| | | Plumtree UI Infrastructure API | |
| | AStartTreeControl Members
|
AStartTreeControl overview
Public Static Fields
  ACTIONSUBTITLE | The action sub-title of the tree |
| ALLOW_EMPTY_SUBMISSION | Allow users to click finish on a tree with nothing selected. default is false |
| CLASS_IDS_TO_DISPLAY | The class IDs of the types of objects you want to display. If you don't want to display any objects (folders only), don't use this. Make sure to include catalogfolder if you want catalogfolders, otherwise only folders will appear. |
| DISPLAYED_ITEMS | classID1,objectID1,classID2,objectID2,etc... This will only display the selected objects. This does not work for IPTFolders. The class IDs still need to be specified and the root folder ID needs to be specified, even though it will be ignored. Normal folder browsing will be ignored |
| HELP_TOPIC | The help topic. |
| HIDDEN_ITEMS | classID1,objectID1,classID2,objectID2,etc... This will display all objects except for the following |
| MULTI_SELECT | true = check boxes, false = radio buttons (multi select vs. single select of objects) |
| ONCLICK_CALL | The name of the javascript function in the parent page to call when tree elements are clicked. This should include the whole path to the function (i.e. parent.myframe.myfunction) without the ending parentheses or semicolon '();'. This should not include the '();'. This function will be called with the clicked input as the only argument in the onclick method of the tree items. It should return true or false depending on whether or not the button should be clicked (true implies it will be clicked, false implies it will not). The function name should also not contain {,},',",\ Using this method will turn off dynamic updating of the 'you have selected' frame, which uses the same mechanism. This should be used extremely sparingly (only in the save page currently). |
| PARENT_FORM_NAME | These two should be used together or not at all. The name of the parent form that you would like the data passed back to. |
| PARENT_FORM_SPACE_ID | The name of the input in the parent form that you would like the AActivitySpace ID of the tree space put into. This is used to reopen the tree after it has been created. |
| PARENT_SUBMIT_CALL | The name of the javascript function in the parent page to call when the tree is submitted. This should not include the '();'. In Javascript submit mode this method should take an array argument which will be made up of objects with name, ObjectID, and ClassID member variables. see ATreeAS for details. Warning: this array will dissapear after the function call is over. If you want to save the items, you must copy them somewhere in your page. The names of the objects will be HTMLEncoded and truncated to 50 characters. |
| SELECT_MODE | See TreeConstants for select modes (leaves vs. folders vs. both) |
| SELECT_OPTIONS | See TreeConstants for select options (strict leaves). Optional. |
| SELECTED_ITEMS | classID1,objectID1,classID2,objectID2,etc... |
| SHOW_ROOT | This determines whether or not the root folder will be displayed. By default, it will be displayed. Pass in true or false. |
| SUBMIT_MODE | See TreeConstants for select modes (server vs. Javascript) |
| TITLE | The title of the tree pop-up |
Public Instance Methods
 CheckActionSecurityAndExecute | |
| Create | This method is used by the ASManager to return new instances of managed objects. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| GetName | |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| Init | |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
Protected Instance Constructors
Protected Instance Fields
Protected Instance Methods
 Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
See Also
AStartTreeControl Class | com.plumtree.uiinfrastructure.tree Namespace
