|
IRISLIB database
|
|
|
IRISLIB database
|
|
This component draws an HTML tree control based on executing a user-provided callback method. More...
Public Member Functions | |
| dragStartHandler (dragData) | |
| Built-in drag handler for tree component. More... | |
| expandAll (flag) | |
| Expand (if flag is true) or contract (if flag is false) all. More... | |
| getNodeParent (nodeNo) | |
| Return the index number (0-based) of the parent of the specified node. More... | |
| getNodeText (nodeNo) | |
| Get the display value of a given node. More... | |
| getNodeValue (nodeNo) | |
| Get the logical value of a given node. More... | |
| getSelectedIndex () | |
| Return the index number (0-based) of the current node. More... | |
| getValue () | |
| Get the logical value of the current selected node. | |
| isNodeExpanded (nodeNo) | |
| This method returns the expanded state of a given nodeNo. More... | |
| itemClicked (idx, level) | |
| User clicked on an item. More... | |
| itemDblClicked (idx, level) | |
| User double-clicked on an item. | |
| reloadNode (nodeNo) | |
| Reload the child nodes of the given node. More... | |
| selectItem (idx) | |
| Select the given node within the tree. More... | |
| setNodeStyle (nodeNo, style) | |
| Set the css style for of a given node. More... | |
| setNodeText (nodeNo, text) | |
| Set the display value of a given node. More... | |
| setNodeValue (nodeNo, value) | |
| Set the logical value of a given node. More... | |
| setProperty (property, value, value2) | |
| Set the value of a named property. More... | |
| toggleExpanded (nodeNo) | |
| Toggle the current expanded state of a given node within the tree. More... | |
 Public Member Functions inherited from component | |
| dragFinishHandler (dragData) | |
| This is called when a drag operation started within this component. More... | |
| dragHandler () | |
| This is called by the layout manager when a drag-and-drop operation. More... | |
| dragNotifyHandler (dragData) | |
| This is called by the layout manager when a drag operation. More... | |
| dropHandler () | |
| This is called by the layout manager when a drag-and-drop operation. More... | |
| dropStartHandler (dragData) | |
| This is called when a data drop operation is started within this component. More... | |
| exposeComponent () | |
| This manages the ondisplay event callback handling. More... | |
| getEnclosingDiv () | |
| Client-side method returns the div element that encloses. More... | |
| _.Library.String | getHidden () |
| Return whether this component is hidden. | |
| getHintElement () | |
| Client-side method returns the HTML element that displays. More... | |
| getLabelElement () | |
| Client-side method returns the HTML element that displays. More... | |
| onDisplayHandler () | |
| This client callback is called from exposeComponent after. More... | |
| onEndModalHandler (zindex) | |
| Notification that this component is about to stop being modal. | |
| onPopupAction (popupName, action, value) | |
| This client event, if present, is fired when a popup page has specified. More... | |
| onRefreshContents () | |
| This client callback is called just from refreshContents. More... | |
| onStartModalHandler (zindex) | |
| Notification that this component is about to become modal. More... | |
| refreshContents (sync) | |
| This method, called from a client page, invokes this component's. More... | |
| setHidden (flag) | |
| If flag is true, hide this component. More... | |
| setOverlayMode (mode) | |
| Expirimental: do not use. More... | |
| startProgressBar (div) | |
| Start the display of a progress bar within display. More... | |
| stopProgressBar () | |
| Stop the timer used by the Progress bar. | |
| Public Member Functions inherited from object | |
| _.Library.Status | OnNew (_.Library.RawString initvalue) |
| Constructor for Zen objects. More... | |
| findElement (subid) | |
| Client-side utility method that finds an HTML element with a. More... | |
| fireOnUpdateEvent () | |
| This is called when an object is updated from the server. More... | |
| _.Library.String | getProperty (property, key) |
| Return the value of a named property (i.e. More... | |
| getSettings (settings) | |
| Client-side method that returns a list of this component's. More... | |
| getType () | |
| Returns the component type of this object. More... | |
| invokeSuper (method, args) | |
| Invoke the superclass method method of the current. More... | |
| isOfType (type) | |
| Returns true if this object is of the given component type. More... | |
| makeId (subid) | |
| client-side utility method that constructs a component-specific id More... | |
| onCreate () | |
| This client method, if present, is called when this component is. More... | |
| onDelete () | |
| This client method, if present, is called when this component is. More... | |
| onSerialize () | |
| This client event, if present, is fired before a component. More... | |
| onloadHandler () | |
| This client event, if present, is fired when the page is loaded. | |
| onunloadHandler () | |
| This client event, if present, is fired when the page is unloaded. More... | |
| onupdateHandler () | |
| This client method, if present, is fired when the object is updated from the server. | |
| render () | |
| This causes a component that draws its contents dynamically. More... | |
| renderContents () | |
| This method, if present, is called when this component. More... | |
| renderSVG (document, parent) | |
| This method is only needed for SVG components. More... | |
| Public Member Functions inherited from RegisteredObject | |
| _.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
| This callback method is invoked when the current object is added to the SaveSet,. More... | |
| _.Library.Status | OnClose () |
| This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
| _.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
| This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
| _.Library.Status | OnNew () |
| This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
| _.Library.Status | OnValidateObject () |
| This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
| Public Member Functions inherited from Adaptor | |
| _.Library.Status | XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments) |
| Serialize an XML enabled class as an XML document and write. More... | |
| _.Library.Status | XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent) |
| Serialize an XML enabled class as an XML document and appends it to a stream. More... | |
| _.Library.Status | XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent) |
| Serialize an XML enabled class as an XML document and write it to a string. More... | |
Public Attributes | |
| OnGetNodeInfo | |
| Name of Server-side callback method to call to get information. More... | |
| OnGetTreeInfo | |
| Name of Server-side callback method to call to get information. More... | |
| childIndent | |
| Specifies amount child nodes should be indented. More... | |
| dataGlobal | |
| If defined, and there is no user-defined <method>OnGetNodeInfo</method> More... | |
| imageContracted | |
| url of image used for contracted tree node (when <property>showLines</property> is false). More... | |
| imageExpanded | |
| url of image used for expanded tree nodes (when <property>showLines</property> is false). More... | |
| imageFolderClosed | |
| url of image used for a closed folder node in the tree. More... | |
| imageFolderOpen | |
| url of image used for an open folder node in the tree. More... | |
| imageNode | |
| url of image used for a leaf node in the tree. More... | |
| nodeCount | |
| This is used to keep track of how many nodes are in this tree. More... | |
| onchange | |
| onchange event handler: More... | |
| onclick | |
| onclick event handler: More... | |
| ondblclick | |
| ondblclick event handler: More... | |
| parameters | |
| User-defined set of parameters. More... | |
| selectedIndex | |
| Index (0-based) of current selected tree node. More... | |
| showFolders | |
| If true and <property>showLines</property> is false, display open and closed folder icons as well as icons for. More... | |
| showLines | |
| If true, show dashed lines (as a series of images) between. More... | |
| text | |
| Text (display) value of current item within the view. More... | |
| value | |
| Logical value of current item within the view. More... | |
| Public Attributes inherited from component | |
| align | |
| Specifies how this component should be horizontally aligned within its layout cell. More... | |
| containerStyle | |
| CSS style applied to the td element used to contain this child component within. More... | |
| dragEnabled | |
| If this value is true and dragAndDrop is enabled for the page, then. More... | |
| dropEnabled | |
| If this value is true and dragAndDrop is enabled for the page, then. More... | |
| enclosingClass | |
| Optional CSS class used for this component's enclosing div. More... | |
| enclosingStyle | |
| Optional CSS style applied to this component's enclosing div. More... | |
| error | |
| Run-time value; Set to indicate an error within this component. More... | |
| height | |
| Specifies the height of this component with respect to its container. More... | |
| hidden | |
| If true, this component is hidden. More... | |
| hint | |
| User defined hint text used to display additional hint text for this component. More... | |
| hintClass | |
| Optional CSS class used for the component hint. More... | |
| hintStyle | |
| User defined style used for the component hint. More... | |
| label | |
| User defined label used to label this component. More... | |
| labelClass | |
| Optional CSS class used for the component label. More... | |
| labelDisabledClass | |
| Optional CSS class used for the component label when disabled. More... | |
| labelStyle | |
| User defined style used for the component label. More... | |
| onafterdrag | |
| onafterdrag event handler: More... | |
| onbeforedrag | |
| onbeforedrag event handler: More... | |
| ondrag | |
| ondrag event handler: More... | |
| ondrop | |
| ondrop event handler: More... | |
| onhide | |
| onhide event handler: More... | |
| onrefresh | |
| onrefresh event handler: More... | |
| onshow | |
| onshow event handler: More... | |
| showLabel | |
| Controls whether a label is displayed for this component. More... | |
| slice | |
| User-defined number of units of relative space this. More... | |
| title | |
| Help text (tool tip) displayed when mouse hovers over this component (or its label). More... | |
| valign | |
| Specifies how this component should be vertically aligned within its layout cell. More... | |
| width | |
| Specifies the width of this component with respect to its container. More... | |
| Public Attributes inherited from object | |
| aux | |
| @qualifier final This is an auxiliary property that is provided More... | |
| composite | |
| @qualifier final For components that are created as part of a composite component, More... | |
| id | |
| @qualifier final This is a unique identifier that is used to distinguish this object More... | |
| index | |
| @qualifier final System-assigned index number used internally to identify this component. More... | |
| name | |
| @qualifier final Name of this object. More... | |
| onupdate | |
| onupdate event handler: More... | |
| parent | |
| @qualifier final Link to the component that contains this object More... | |
| tuple | |
| @qualifier final Special property indicating which tuple of a More... | |
| visible | |
| This property indicates whether a component is visible and thus layed out. More... | |
| window | |
| @qualifier final This is a client-only property that refers to the JavaScript More... | |
Static Public Attributes | |
| IMAGECONTRACTED = None | |
| Default url of image used for contracted tree node. More... | |
| IMAGEEXPANDED = None | |
| Default url of image used for expanded tree node. More... | |
| IMAGEFOLDERCLOSED = None | |
| Default url of image used for closed folder nodes. | |
| IMAGEFOLDEROPEN = None | |
| Default url of image used for open folder nodes. | |
| IMAGENODE = None | |
| Default url of image used for a leaf node in the tree. | |
| Static Public Attributes inherited from component | |
| DEFAULTENCLOSINGCLASS = None | |
| Subclasses can set this to change default enclosingClass used for this. More... | |
| DEFAULTHEIGHT = None | |
| Subclasses can set this to change default height for a component. | |
| DEFAULTHIDDEN = None | |
| Subclasses can set this to change default hidden property for a component. | |
| DEFAULTHINTCLASS = None | |
| Subclasses can set this to change default css class used for hints. | |
| DEFAULTLABELCLASS = None | |
| Subclasses can set this to change default css class used for labels. | |
| DEFAULTLABELDISABLEDCLASS = None | |
| Subclasses can set this to change default css class used for disabled labels. | |
| DEFAULTVISIBLE = None | |
| Subclasses can set this to change default visibilty for a component. | |
| DEFAULTWIDTH = None | |
| Subclasses can set this to change default width for a component. | |
| Static Public Attributes inherited from object | |
| DEFAULTVISIBLE = None | |
| Subclasses can set this to change default visibilty for a component. | |
| INCLUDEFILES = None | |
| CSV list of additional include files (either .js or .css) that. More... | |
| MODULE = None | |
| If set, this indicates that this system component should be. More... | |
| NAMESPACE = None | |
| This is the XML namespace used for library components. | |
| POSTCOMPILEACTIONS = None | |
| This is a comma-delimited list of which post-compile actions this component. More... | |
| USECOMMONDIRECTORY = None | |
| If true, then the include files generated for this component, are placed in the. More... | |
| XMLFORMAT = None | |
| If XMLFORMAT="Literal", then only support for literal format import and export is generated. More... | |
| XMLIGNOREINVALIDATTRIBUTE = None | |
| By setting this to 0, we disallow use of invalid attribute names in Zen XML documents. | |
| Static Public Attributes inherited from RegisteredObject | |
| CAPTION = None | |
| Optional name used by the Form Wizard for a class when generating forms. More... | |
| JAVATYPE = None | |
| The Java type to be used when exported. | |
| PROPERTYVALIDATION = None | |
| This parameter controls the default validation behavior for the object. More... | |
| Static Public Attributes inherited from Adaptor | |
| ATTRIBUTEQUALIFIED = None | |
| ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More... | |
| ELEMENTQUALIFIED = None | |
| ELEMENTQUALIFIED controls the format of exported XML. More... | |
| NAMESPACE = None | |
| NAMESPACE specifies the XML namespace to be used when projecting the. More... | |
| SUPPRESSTYPEPREFIX = None | |
| SUPPRESSTYPEPREFIX allows the type name that refers to this class. More... | |
| XMLDEFAULTREFERENCE = None | |
| XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More... | |
| XMLENABLED = None | |
| If this parameter is true then XML-enabling methods. More... | |
| XMLFORMAT = None | |
| The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More... | |
| XMLIGNOREINVALIDATTRIBUTE = None | |
| The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More... | |
| XMLIGNOREINVALIDTAG = None | |
| The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More... | |
| XMLIGNORENULL = None | |
| XMLIGNORENULL allows the programmer to override the default XML handling. More... | |
| XMLINCLUDEINGROUP = None | |
| XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More... | |
| XMLINHERITANCE = None | |
| If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More... | |
| XMLNAME = None | |
| This parameter provides the default XMLNAME for the class. More... | |
| XMLNIL = None | |
| The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More... | |
| XMLNILNOOBJECT = None | |
| The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More... | |
| XMLPREFIX = None | |
| The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More... | |
| XMLSEQUENCE = None | |
| If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More... | |
| XMLSUMMARY = None | |
| The summary fields to be used when an object is referenced are specified. More... | |
| XMLTYPE = None | |
| This parameter provides the default XMLTYPE for the class. More... | |
| XMLUNSWIZZLE = None | |
| If the XMLUNSWIZZLE parameter is set to 1, then single object. More... | |
| XMLUSEEMPTYELEMENT = None | |
| If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More... | |
Private Member Functions | |
| DrawHTML () | |
| Draw HTML for this component. | |
Static Private Member Functions | |
| _.Library.String | GetImageDirectory () |
| Return the directory from which built-in images are supplied. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Adaptor | |
| _.Library.Status | XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist) |
| Write the DTD to the current device for this XML enabled class serialized as. More... | |
| _.Library.RegisteredObject | XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref) |
| Get an instance of an XML enabled class. More... | |
| _.Library.Status | XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema) |
| Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More... | |
| _.Library.String | XMLSchemaNamespace () |
| Get the namespace to which this class belongs for use in schema generation. More... | |
| _.Library.Status | XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly) |
| Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More... | |
This component draws an HTML tree control based on executing a user-provided callback method.
There are several ways that you can provide data for the tree control:
| dragStartHandler | ( | dragData | ) |
Built-in drag handler for tree component.
Let the user drag the selected node.
Reimplemented from component.
Reimplemented in SMPDynaTree.
| expandAll | ( | flag | ) |
Expand (if flag is true) or contract (if flag is false) all.
nodes within the true; Does not invoke any callback methods.
| getNodeParent | ( | nodeNo | ) |
Return the index number (0-based) of the parent of the specified node.
nodeNo is the index number of the node (0-based).
| getNodeText | ( | nodeNo | ) |
Get the display value of a given node.
nodeNo is the index number of the node (0-based). If nodeNo is not provided use the current selected noded.
| getNodeValue | ( | nodeNo | ) |
Get the logical value of a given node.
nodeNo is the index number of the node (0-based). If nodeNo is not provided use the current selected noded.
| getSelectedIndex | ( | ) |
Return the index number (0-based) of the current node.
Return -1 if no node is selected.
| isNodeExpanded | ( | nodeNo | ) |
This method returns the expanded state of a given nodeNo.
true = expanded.
| itemClicked | ( | idx, | |
| level | |||
| ) |
User clicked on an item.
idx is index of node (0 based). level is indentation level of node (0 based); this is passed on to the callback.
| reloadNode | ( | nodeNo | ) |
Reload the child nodes of the given node.
nodeNo is the index number of the node (0-based).
This method does nothing if it called for a leaf node (a node without children).
This method only works when the <property>OnGetTreeInfo</property> callback is used to supply the contents of the tree.
| selectItem | ( | idx | ) |
Select the given node within the tree.
idx is index of node (0 based).
| setNodeStyle | ( | nodeNo, | |
| style | |||
| ) |
Set the css style for of a given node.
style should contain css style declarations (e.g., 'color: red;')
nodeNo is the index number of the node (0-based).
| setNodeText | ( | nodeNo, | |
| text | |||
| ) |
Set the display value of a given node.
nodeNo is the index number of the node (0-based).
| setNodeValue | ( | nodeNo, | |
| value | |||
| ) |
Set the logical value of a given node.
nodeNo is the index number of the node (0-based).
| setProperty | ( | property, | |
| value, | |||
| value2 | |||
| ) |
| toggleExpanded | ( | nodeNo | ) |
Toggle the current expanded state of a given node within the tree.
nodeNo is the index number of the node (0-based).
|
static |
Default url of image used for contracted tree node.
This is only used when <property>showLines</property> is false.
|
static |
Default url of image used for expanded tree node.
This is only used when <property>showLines</property> is false.
| OnGetNodeInfo |
Name of Server-side callback method to call to get information.
for each node of this tree.
This must be the name of a server-only method in the page class that contains this component.
| OnGetTreeInfo |
Name of Server-side callback method to call to get information.
for the entire contents of the tree.
This is a lower-level callback than the <property>OnGetNodeInfo</property> callback. It lets you define the contents of the entire tree using a multi-dimensional array.
If this is defined then the <property>OnGetNodeInfo</property> callback is not used.
This must be the name of a server-only method in the page class that contains this component.
The callback method should be similar to this:
ClassMethod GetTreeInfo(pRoot As String, Output pTree, ByRef pParms) As Status { #; top-most nodes are children of 0 Set pTree(0,"ch",1) = "" Set pTree(0,"ch",2) = "" Set pTree(0,"ch",3) = ""
#; each node supplies: $LB(caption, value, hasChildren, link, expanded, icon, tooltip, style) Set pTree(1) = $LB("Animal",1,1,"",1) Set pTree(2) = $LB("Mineral",2,1,"",1) Set pTree(3) = $LB("Vegetable",3,1,"",1)
#; child nodes are placed under "ch" Set pTree(1,"ch",4) = ""
Set pTree(4) = $LB("Cow",4,0,"",1) Quit $$$OK }
| childIndent |
Specifies amount child nodes should be indented.
This value is only applied when <property>showLines</property> is false.
| dataGlobal |
If defined, and there is no user-defined <method>OnGetNodeInfo</method>
callback method, then this is the name of a global that is used to provide the contents of this tree.
The global takes the form:
^glvn("A","B") = URL
The global subscripts define the node names; The URL value is a link that is used when the user clicks on the node.
| imageContracted |
url of image used for contracted tree node (when <property>showLines</property> is false).
| imageExpanded |
url of image used for expanded tree nodes (when <property>showLines</property> is false).
If you set this, make sure you also set <property>imageContracted</property>.
| imageFolderClosed |
url of image used for a closed folder node in the tree.
If not specified, a default image is supplied.
| imageFolderOpen |
url of image used for an open folder node in the tree.
If not specified, a default image is supplied.
| imageNode |
url of image used for a leaf node in the tree.
If not specified, a default image is supplied.
| nodeCount |
This is used to keep track of how many nodes are in this tree.
| onchange |
onchange event handler:
If defined, this event is fired when the user changes the value of this component.
| onclick |
onclick event handler:
If defined, this event is fired when the user clicks on an item
| ondblclick |
ondblclick event handler:
If defined, this event is fired when the user double-clicks on an item
| parameters |
User-defined set of parameters.
These values are passed on
to the user callback function that provides the contents of this view. Typically this is used to hold search parameters.
| selectedIndex |
Index (0-based) of current selected tree node.
| showFolders |
If true and <property>showLines</property> is false, display open and closed folder icons as well as icons for.
each node in the tree. The default is true.
If <property>showLines</property> is true, this property is ignored.
| showLines |
If true, show dashed lines (as a series of images) between.
the nodes of the tree.
Text (display) value of current item within the view.
Do not access this directly; use getProperty('text') instead.
| value |
Logical value of current item within the view.
Do not access this directly; use getProperty('value') instead.
1.9.1