IRISLIB database
navigator Class Reference

The navigator component creates a combination navigation and simple settings interface similar to that found on mobile devices. More...

Inheritance diagram for navigator:
Collaboration diagram for navigator:

Public Member Functions

 applyValue (value, display, pop)
 Apply the value value and display value display to the current item. More...
 
 beginWait ()
 Start "wait" state.
 
 choiceClick (evt, multi, index, choiceNo, newValue)
 Mouse click handler for choice control. More...
 
 clickHandler (evt, index, forceDrill)
 Click handler for item in sheet.
 
 closeButtonClickHandler (evt, key)
 Click handler for close button.
 
 colorSetChange (value)
 Change the displayed color set.
 
 convertCSSToText (result)
 Convert an object containing css values as name-values into a css string. More...
 
 editClick (evt, index)
 Mouse click on edit control.
 
 editControlApply (evt, index)
 Apply button for edit control.
 
 editControlCancel (evt, index)
 Cancel button for edit control.
 
 editKeyPressHandler (evt, index)
 Key press handler for edit control.
 
 editKeyUpHandler (evt, index)
 Key up handler for edit control.
 
 endWait ()
 End "wait" state .
 
 expandHandler ()
 Fire the onexpand event handler.
 
 findItemByIndex (index, level)
 Return the item with the given index (and optional level).
 
 getChooserListHTML (list, key, value, caption, help)
 Utility method. More...
 
 getColorChooserHTML (key, value, mode)
 Return the HTML for a color chooser panel. More...
 
 getColorSet (mode)
 Return an array of (arrays of) the current color set.
 
 getColorTableHTML (mode, value)
 Return a HTML for the table of color choices for the current color set.
 
 getCurrSpec ()
 Return the spec object for the current frame.
 
 getFontChooserHTML (key, value)
 Utility method. More...
 
 getHTMLForEditor (index, item, active, disabled)
 Return HTML for a value editor. More...
 
 getHTMLForItem (index, item, active)
 Return HTML for one item.
 
 getIconListHTML (list, key, value)
 Utility method. More...
 
 getItemContent (index, item, active)
 Return HTML for the contents of an item. More...
 
 getItemDiv (level, index)
 Find the div element for the given item level and index.
 
 getLevelContent (level, itemSpec)
 Return the HTML content for the given level. More...
 
 getMasterContent (showExtra)
 Get the HTML contents of the master panel tray.
 
 getMultiSelectIconListHTML (list, key, value)
 Utility method. More...
 
 getNavFooterHTML (level)
 Get HTML for the footer bar.
 
 getNavHeaderHTML (level)
 Get HTML for the navigator bar (header for master panel).
 
 getParentSpec ()
 Return the spec object for the parent of the current frame.
 
 getWidth ()
 Get the expected width of this component in pixels.
 
 giveFocusToControl ()
 Give focus to the current input control.
 
 headerButtonClickHandler (key, level)
 Click handler for header (or footer) button.
 
 hideMessage ()
 Hide the message for this form.
 
 hideOverlay ()
 Hide the overlay.
 
 onPopupAction (popupName, action, value)
 This client event, if present, is fired when a popup page has specified. More...
 
 onloadHandler ()
 This client event, if present, is fired when the page is loaded.
 
 parseStyle (style)
 Utility method. More...
 
 parseStyleSVG (style)
 Utility method. More...
 
 popSheet ()
 Pop the top sheet (html div) off of the stack and render it. More...
 
 popupButtonClickHandler (evt, key, url)
 Click handler for popup button.
 
 pushSheet (itemSpec)
 Push a new item onto the stack.
 
 raiseChange (key, value, final)
 Raise the onchange event for this navigator. More...
 
 refreshTopSheet ()
 Refresh the contents of the current top sheet.
 
 renderContents ()
 Draw contents of the property sheet.
 
 selectItem (index, forceDrill)
 Select the item with the given index.
 
 setExpanded (flag)
 Expand or contract the display of this component.
 
 setHeight (height)
 Set the height (pixels) of this component.
 
 setProperty (property, value, value2)
 Set the value of a named property.
 
 setStyleIntoCSS (cssText, style, value)
 Utility method. More...
 
 setWidth (width)
 Set the column width (pixels) of this component.
 
 showMessage (msg)
 Display a message for this form.
 
 showOverlay (content)
 Show the given content in the overlay.
 
 slideInto (item)
 Slide a new item onto the stack and render it (with animation). More...
 
 slideOutOf ()
 Slide top item off of the stack and re-render (with animation).
 
 sliderChanged (index, newValue, final)
 Notification that a slider has moved. More...
 
 sliderMouseDown (evt, index)
 Mouse down handler for slider control.
 
 sliderMouseMove (evt)
 Mouse move handler for slider control (connected to window).
 
 sliderMouseUp (evt)
 Mouse up handler for slider control (connected to window).
 
 sliderToggleClick (evt, index)
 Click on slider toggle checkbox.
 
 sliderTouchEnd (evt)
 Touch end handler for slider control (connected to window).
 
 sliderTouchMove (evt)
 Touch move handler for slider control.
 
 sliderTouchStart (evt, index)
 TouchStart down handler for slider control.
 
 sliderValueChange (event, index)
 Notification that the user has entered an explicit value in the value text box.
 
 startEdit (index)
 Start editing within the item with the given index.
 
 stepperAction (which, index, delay)
 Apply stepper action.
 
 stepperMouseDown (which, index)
 Mouse down on stepper control.
 
 stepperMouseUp (which, index)
 Mouse up on stepper control.
 
 stopEdit (index, cancel)
 Stop editing within the item with the given index.
 
 toggleExpanded ()
 Expand or contract the display of this component.
 
 toggleSwitch (index)
 Toggle value of switch control.
 
 transformColor (color)
 Some charts may have use SVG colors. More...
 
 tryValue (value, tryLevel)
 Do a trial application of the value value to the current item. More...
 
 update (reset)
 Refresh the contents of the property sheet. More...
 
 updateMasterPanel (showExtra)
 Refresh the contents of the master panel.
 
- Public Member Functions inherited from group
 LayoutChildren (_.Library.Integer pTuple)
 Does the actual work of laying out the children of this group. More...
 
- Public Member Functions inherited from abstractGroup
 addChild (component, refresh)
 Client-side method. More...
 
 addChildAfter (component, sibling, refresh)
 Client-side method. More...
 
 addChildBefore (component, sibling, refresh)
 Client-side method. More...
 
 childrenMutated ()
 Notification to subclasses that a child has been added or removed. More...
 
 exposeComponent ()
 This manages the ondisplay event callback handling. More...
 
 getChildIndex (child)
 Look for the given child object within this group's set of. More...
 
 onRefreshContents ()
 This client event, if present, is fired when the page is loaded.
 
 ondisabledHandler ()
 Client-side method that is called when a group's disabled. More...
 
 removeChild (component)
 Client-side method. More...
 
 setOverlayMode (mode)
 Set overlay mode for each child of this group.
 
 setPropertyAll (property, value, value2)
 Apply the given value to the specified property for. 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...
 
 dragStartHandler (dragData)
 This is called when a drag operation is started within this component. 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...
 
 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.
 
 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...
 
 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...
 
 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...
 
 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...
 

Static Public Member Functions

_.ZEN.Datatype.string GetUserFontList ()
 The default list of fonts available may be extended by editing the global. More...
 
- 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...
 

Public Attributes

 backgroundStyle
 Style to apply to navigator background. More...
 
 colorSetCaptions
 Captions of color sets. More...
 
 colorSetNames
 Logical names of color sets. More...
 
 colorSets
 List of ;-delimited color set values for drop down. More...
 
 columnWidth
 Width of columns (in pixels). More...
 
 currColorSet
 Current color set. More...
 
 currLevel
 Indicates how many levels deep the navigator is scrolled. More...
 
 deleteThisItemMsg
 Warning tooltip message for delete options. More...
 
 disclosureWidth
 Width of the disclosure bar on the left. More...
 
 expanded
 If true, then show the navigator; otherwise it is contracted. More...
 
 footerHeight
 Height of footer (in pixels). More...
 
 headerHeight
 Height of header (in pixels). More...
 
 language
 Pass current language to client. More...
 
 onarrange
 onarrange event handler: More...
 
 onbuttonclick
 onbuttonclick event handler: More...
 
 onchange
 onchange event handler: More...
 
 onclosebuttonclick
 onclosebuttonclick event handler: More...
 
 onexpand
 onexpand event handler: More...
 
 ongetcontent
 ongetcontent event handler: More...
 
 onindent
 onindent event handler: More...
 
 onpopupaction
 onpopupaction event handler: More...
 
 onselect
 onselect event handler: More...
 
 openThisItemMsg
 Warning tooltip message for open options. More...
 
 showDisclosure
 If true, show the disclosure bar on the left. More...
 
 showSliderValue
 If true, show slider values next to the control. More...
 
- Public Attributes inherited from group
 cellAlign
 Specifies horizontal alignment of cells layed out within this group. More...
 
 cellSize
 Specifies how the size of cells within this group should be calculated (along layout direction). More...
 
 cellStyle
 Specifies additional style for cells layed out within this group. More...
 
 cellVAlign
 Specifies vertical alignment of cells layed out within this group. More...
 
 groupClass
 Optional CSS class used for table displayed by this group. More...
 
 groupStyle
 Optional style used for table displayed by this group. More...
 
 labelPosition
 Specifies where labels should be displayed for components within this group. More...
 
 layout
 Specifies how components within this group should be layed out. More...
 
 onclick
 onclick event handler: More...
 
- Public Attributes inherited from abstractGroup
 children
 Set of components within this group. More...
 
 disabled
 If true, this group and its children are disabled. 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

 DOMAIN = None
 Localization domain.
 
- Static Public Attributes inherited from group
 DEFAULTCELLALIGN = None
 Subclasses can set this to change default cellAlign for a group.
 
 DEFAULTCELLSIZE = None
 Subclasses can set this to change default cellSize for a group.
 
 DEFAULTCELLSTYLE = None
 Subclasses can set this to change default cellStyle for a group.
 
 DEFAULTCELLVALIGN = None
 Subclasses can set this to change default cellVAlign for a group.
 
 DEFAULTGROUPCLASS = None
 Subclasses can set this to change default css class for a group.
 
 DEFAULTGROUPSTYLE = None
 Subclasses can set this to change default groupStyle for a group.
 
 DEFAULTLABELPOSITION = None
 Subclasses can set this to change default labelPosition for a group.
 
 DEFAULTLAYOUT = None
 Subclasses can set this to change default layout for a group.
 
- Static Public Attributes inherited from abstractGroup
 DEFAULTGROUPCLASS = None
 Subclasses can set this to change default css class for a group.
 
- 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 ()
 Static HTML display method: draw the BODY of this component. More...
 

Detailed Description

The navigator component creates a combination navigation and simple settings interface similar to that found on mobile devices.


This is an HTML5 component; it will only work correctly on HTML5 compliant browsers.

Member Function Documentation

◆ DrawHTML()

DrawHTML ( )
private

Static HTML display method: draw the BODY of this component.

as HTML.
Subclasses implement this in order to render the static HTML contents of a component.

Reimplemented from group.

◆ GetUserFontList()

_.ZEN.Datatype.string GetUserFontList ( )
static

The default list of fonts available may be extended by editing the global.

^zenNavigator.UserFontListCSV. This is a flat string holding the names of desired fonts, separated by commas (i.e. "Palatino Linotype,Tahoma") Names are case sentitive and subject to substitution if the named font is not found on the run time system. This function passes the value of the global to the client side renderer.

◆ applyValue()

applyValue (   value,
  display,
  pop 
)

Apply the value value and display value display to the current item.

display is not passed to the callback. You can get it via the currDisplayValue property of this component.
If pop is true, pop the current frame on the navigator.

◆ choiceClick()

choiceClick (   evt,
  multi,
  index,
  choiceNo,
  newValue 
)

Mouse click handler for choice control.

multi is true for choice-multi.

◆ convertCSSToText()

convertCSSToText (   result)

Convert an object containing css values as name-values into a css string.

This is used for SVG styles.

◆ getChooserListHTML()

getChooserListHTML (   list,
  key,
  value,
  caption,
  help 
)

Utility method.

Given a list of objects, of the form: [{caption:caption, value:value, style:style}]
key and value are the key and value for item within the navigator. Return HTML to display a chooser list based on the given values. If caption and help are defined, display them at the top.

◆ getColorChooserHTML()

getColorChooserHTML (   key,
  value,
  mode 
)

Return the HTML for a color chooser panel.

key and value are the key and value for item within the navigator. mode</mode> is "html" or "svg".

◆ getFontChooserHTML()

getFontChooserHTML (   key,
  value 
)

Utility method.

Return the HTML for a font chooser panel. key and value are the key and value for item within the navigator.

◆ getHTMLForEditor()

getHTMLForEditor (   index,
  item,
  active,
  disabled 
)

Return HTML for a value editor.

This draws an edit control within an item.

◆ getIconListHTML()

getIconListHTML (   list,
  key,
  value 
)

Utility method.

Display a set of choices as icons. Given a list of objects, of the form: [{image:url, caption:caption, value:value, style:style}]
key and value are the key and value for item within the navigator. Return HTML to display a chooser list based on the given values.

◆ getItemContent()

getItemContent (   index,
  item,
  active 
)

Return HTML for the contents of an item.

This draw the various cells and controls within a sheet.

◆ getLevelContent()

getLevelContent (   level,
  itemSpec 
)

Return the HTML content for the given level.

itemSpec is the spec object for the parent of the current level. It is null for the top-most level.

◆ getMultiSelectIconListHTML()

getMultiSelectIconListHTML (   list,
  key,
  value 
)

Utility method.

Display a set of choices as icons. Given a list of objects, of the form: [{image:url, caption:caption, value:value, style:style}]
key and value are the key and value for item within the navigator. Return HTML to display a multi-select supporting chooser

◆ onPopupAction()

onPopupAction (   popupName,
  action,
  value 
)

This client event, if present, is fired when a popup page has specified.

this component as its parent and fires an action.

Reimplemented from component.

◆ parseStyle()

parseStyle (   style)

Utility method.

Split a css value into individual style values.

Return an object containing these values. In addition to normal css attributes, the special attributes: "bold", "displayed","italic","underline", "smallCaps", and "shadow" are returned.

◆ parseStyleSVG()

parseStyleSVG (   style)

Utility method.

Split an SVG css value into individual style values.

Return an object containing these values.

◆ popSheet()

popSheet ( )

Pop the top sheet (html div) off of the stack and render it.

Return the current stack level.

◆ raiseChange()

raiseChange (   key,
  value,
  final 
)

Raise the onchange event for this navigator.

This is used by custom content.

◆ setStyleIntoCSS()

setStyleIntoCSS (   cssText,
  style,
  value 
)

Utility method.

Set a specific css value into the given style string.

◆ slideInto()

slideInto (   item)

Slide a new item onto the stack and render it (with animation).

item is an object describing the new sheet to display.

◆ sliderChanged()

sliderChanged (   index,
  newValue,
  final 
)

Notification that a slider has moved.

newValue is the new value.

◆ transformColor()

transformColor (   color)

Some charts may have use SVG colors.

This is a crude translator.

◆ tryValue()

tryValue (   value,
  tryLevel 
)

Do a trial application of the value value to the current item.

This is used by mouse-over on certain controls.

◆ update()

update (   reset)

Refresh the contents of the property sheet.

If reset is true, unhighlight and unscroll the contents.

Member Data Documentation

◆ backgroundStyle

backgroundStyle

Style to apply to navigator background.

 

◆ colorSetCaptions

colorSetCaptions

Captions of color sets.

 

◆ colorSetNames

colorSetNames

Logical names of color sets.

 

◆ colorSets

colorSets

List of ;-delimited color set values for drop down.

 

◆ columnWidth

columnWidth

Width of columns (in pixels).

Keep at 320 for best results.  

◆ currColorSet

currColorSet

Current color set.

 

◆ currLevel

currLevel

Indicates how many levels deep the navigator is scrolled.

 

◆ deleteThisItemMsg

deleteThisItemMsg

Warning tooltip message for delete options.

 

◆ disclosureWidth

disclosureWidth

Width of the disclosure bar on the left.

 

◆ expanded

expanded

If true, then show the navigator; otherwise it is contracted.

 

◆ footerHeight

footerHeight

Height of footer (in pixels).

Set to 0 for no footer.

Set to 40 to show footer with best results.  

◆ headerHeight

headerHeight

Height of header (in pixels).

Keep at 40 for best results.  

◆ language

language

Pass current language to client.

 

◆ onarrange

onarrange

onarrange event handler:

Notification that the order of items in the current sheet has changed. This event is passed 3 arguments: key, swap, and final. final is true when a value is finished changing. swap is an object with the property index and newIndex, containg the index of the item to move and its new location.  

◆ onbuttonclick

onbuttonclick

onbuttonclick event handler:

Notification that the user has clicked on a "header" or "footer" button.  

◆ onchange

onchange

onchange event handler:

Notification that a control within the property sheet has changed value. This event is passed 3 arguments: key, value, and final. final is true when a value is finished changing (such as when the user stops pressing a stepper button).  

◆ onclosebuttonclick

onclosebuttonclick

onclosebuttonclick event handler:

Notification that the user has clicked on an "close" button for an item.  

◆ onexpand

onexpand

onexpand event handler:

Notification that the user has expanded or contracted this component.  

◆ ongetcontent

ongetcontent

ongetcontent event handler:

This defines the client-side code that defines the content of a "sheet" within this component.
This is passed level</level>, key, and value as arguments. This code should return an object with any of the following properties:
title-the title to display for the sheet.
url-if defined, the url to display as an iframe within the sheet (in the same domain).
html-custom html to display within the sheet.
childIndex-index number (0-based) of child of this component to display.
items-array of javascript objects used to define the contents.
 

◆ onindent

onindent

onindent event handler:

Notification that the indentation level of an item in the current sheet has changed. This event is passed 3 arguments: key, list, and final. final is true when a value is finished changing. list is a an array containing the new ordinal positions of the items.  

◆ onpopupaction

onpopupaction

onpopupaction event handler:

Notification that the user has invoked and applied a popup for an item.  

◆ onselect

onselect

onselect event handler:

Notification that a new choice has been selected within the property sheet. This is also called when a "drill" item is selected. This event is passed 3 arguments: key, value, and which. which is "select" or "drill".  

◆ openThisItemMsg

openThisItemMsg

Warning tooltip message for open options.

 

◆ showDisclosure

showDisclosure

If true, show the disclosure bar on the left.

 

◆ showSliderValue

showSliderValue

If true, show slider values next to the control.