arrowscrollbox

A box containing elements that may extend from its screen area so they are scrolled vertically. Two arrow controls are displayed at the top and bottom for scrolling.

Attributes inherited from box

width The width of the element's box
height The height of the element's box

Attributes inherited from DTXElement

id An identifier for the element.
class The name of a CSS class to be applied to the element.
style An inline CSS style to be applied to the element. CSS rules in this property will take precedence over the ones in the CSS class.
hidden Controls whether the element is visible.
index Suggests the order in which the element should appear within the container element.
priority Suggests the priority for the element. Some DTX controls, like the toolbar, may use the element's priority to determine which elements should be hidden when there is insufficient screen space. The lower this value the bigger chance the element will remain on screen. Set to -1 for elements that should not be hidden.
optional If set to "true", the element may be hidden by the user. If set to "false", the element cannot be hidden by the user.
persist A space-separated list of attributes whose values persist from one session to another. For instance, a value equal to "hidden optional index" will keep the values for the hidden, optional and index attributes.
Release Notes
1.0.1.05 Attributes set to persist will be synchronized between current instances of the toolbar.
title A title for the element. This title may be used in Preferences or other areas of the UI to identify this element.
defaultimage An icon for the element. This title may be used in Preferences or other areas of the UI to identify this element.
track Set to "true" to have this element tracked by the stats system.
flex For elements inside a box, indicates the flexibility of the element, which indicates how an element's container distributes remaining empty space among its children. Flexible elements grow and shrink to fit their given space. Elements with larger flex values will be made larger than elements with lower flex values, at the ratio determined by the two elements. The actual value is not relevant unless there are other flexible elements within the same container. Once the default sizes of elements in a box are calculated, the remaining space in the box is divided among the flexible elements, according to their flex ratios. Specifying a flex value of 0 has the same effect as leaving the flex attribute out entirely.
float When inside a toolbar, an element may be set to float to the right or to the left. Set this property to either "left" or "right".
autohidden On a resize event, if the "autohidden" attribute is set to "true", the element will not be visible on the toolbar or in the chevron menu. If enough space is available, the element will show in the toolbar again.
template The path in the chrome folder to a XSL stylesheet. The element will load the stylesheet and apply it to the XML feed specified by the "feed" attribute. The results of this XSL transform should be a series of DTX XML nodes. These nodes will become the contents of the current element.
Release Notes
1.0.1.05 Added two parameters to the XSL stylesheet: "toolbarId" and "applicationId". They contain the toolbar and application identifiers, respectively. By using these parameters, it is possible to write generic XSL transforms that will work on different toolbars.
feed The URL to an XML feed that will be used to create the contents of this element. The element will load the stylesheet specified in the "template" attribute and apply it to this XML feed. The results of this XSL transform should be a series of DTX XML nodes. These nodes will become the contents of the current element.
cachefile The name for a local file where the XML specified by the feed attribute will be cached. The expiration of this cache is controlled by the templateinterval attribute.
templateinterval Number of minutes that will elapse before the XML specified in the feed attribute will be retrieved again.
tooltiptext This text will be displayed as a tooltip when the mouse cursor stays for a while over the element.
templateid This ID can be used by DTX templates to bind to the element.
Release Notes
1.0.1.02 Added "templateid" attribute to all elements
nonserialize If set to true, the element will not be serialized along with its peers when a parent element calls "saveToXML()"
Release Notes
1.0.1.05 Added "nonserialize" attribute to all elements.
oncommand This event is fired when the default command is performed by the user on the element.
onclick This event is fired as a response to a mouse click.
onmousedown This event is fired when the user presses a mouse button inside the element's area.
onmouseup This event is fired when the user releases the mouse button inside the element's area.
onmousemove This event is fired when the mouse moves inside the element's area.
onmouseover This event is fired when the mouse enters the element's area.
onmouseout This event is fired when the mouse leaves the element's area.
onattributechange Notifies if a persisting attribute has changed in the element.
onafterupdate This event is fired after the element has been rendered.
ongetoptions This event is sent to the element so it can populate an options panel for the element.
ongetprefpane This event is sent to the element so it can create its own panel in the preferences window. This event is sent only to elements in the toolbar.

Events inherited from DTXElement

command This event is fired when the default command is performed by the user on the element.
Parameters
target : object Contains a reference to the element on which the event occurred.
click This event is fired as a response to a mouse click.
Parameters
target : object Contains a reference to the element on which the event occurred.
cancelBubble : boolean The event handler function may modify the value of this property. By default it is set to false, which makes the event bubble up in the parent hierarchy. If it is set to true it will stop the event bubbling.
mousedown This event is fired when the user presses a mouse button inside the element's area.
Parameters
target : object Contains a reference to the element on which the event occurred.
cancelBubble : boolean The event handler function may modify the value of this property. By default it is set to false, which makes the event bubble up in the parent hierarchy. If it is set to true it will stop the event bubbling.
mouseup This event is fired when the user releases the mouse button inside the element's area.
Parameters
target : object Contains a reference to the element on which the event occurred.
cancelBubble : boolean The event handler function may modify the value of this property. By default it is set to false, which makes the event bubble up in the parent hierarchy. If it is set to true it will stop the event bubbling.
mousemove This event is fired when the mouse moves inside the element's area.
Parameters
target : object Contains a reference to the element on which the event occurred.
cancelBubble : boolean The event handler function may modify the value of this property. By default it is set to false, which makes the event bubble up in the parent hierarchy. If it is set to true it will stop the event bubbling.
mouseover This event is fired when the mouse enters the element's area.
Parameters
target : object Contains a reference to the element on which the event occurred.
cancelBubble : boolean The event handler function may modify the value of this property. By default it is set to false, which makes the event bubble up in the parent hierarchy. If it is set to true it will stop the event bubbling.
Release Notes
1.0.0.9 Added event "mouseover" to all elements
mouseout This event is fired when the mouse leaves the element's area.
Parameters
target : object Contains a reference to the element on which the event occurred.
cancelBubble : boolean The event handler function may modify the value of this property. By default it is set to false, which makes the event bubble up in the parent hierarchy. If it is set to true it will stop the event bubbling.
attributechange Notifies if a persisting attribute has changed in the element.
Parameters
target : object Contains a reference to the element on which the event occurred.
attrid : string The ID of the attribute that changed.
value : string The new value for the attribute.
afterupdate This event is fired after the element has been rendered.
Parameters
target : object Contains a reference to the element on which the event occurred.
getoptions This event is sent to the element so it can populate an options panel for the element.
Parameters
target : object Contains a reference to the element on which the event occurred.
node : object A DTX element where the controls for the options panel should be inserted.
window : object The W3C Window interface where the panel is hosted.
document : object The W3C Document interface where the panel is hosted.
getprefpane This event is sent to the element so it can create its own panel in the preferences window. This event is sent only to elements in the toolbar.
Parameters
result : object The event handler could place an instance of prefpane in this property. If so, this panel will appear in the preferences window.
node : object A DTX element where the controls for the options panel should be inserted.
window : object The W3C Window interface where the panel is hosted.
document : object The W3C Document interface where the panel is hosted.

Properties inherited from DTXElement

tagName : string Contains the tag name for the element. Do not modify this property.
childNodes : object An array of child elements. Do not modify this array directly, always use methods like appendChild(), removeChild(), and so on.
framework : object The framework object where this element was created. Do not modify this property.

Methods inherited from DTXElement

setAttribute Sets a value for an attribute in the element.
Parameters
attrid : string Attribute identifier for the attribute being set.
value : string A string that contains the value for the attribute.
getAttribute Returns the value for an attribute in the element. Will return a string value if the attribute is defined, null if undefined.
Returns: string
Parameters
attrid : string Attribute identifier for the attribute being retrieved.
appendChild Appends an element to the childNodes collection.
Parameters
element : object A DTX Element to be appended to the childNodes collection.
removeChild Removes an element from the childNodes collection.
Parameters
element : object The DTX Element to be removed from the childNodes collection.
removeAll Removes all elements from the childNodes collection.
loadFromFile Loads the contents of the element from a file in the Chrome directory. This file must contain DTX XML tags.
Parameters
fileName : string A path relative to the Chrome directory.
loadFromXML Loads the contents of the element from an XML node. The XML node must adhere to the DTX XML Schema.
Parameters
xmlNode : object A W3C XML node that describes the element to be loaded.
saveToXML Serializes the contents of the element to an XML node.
Parameters
xmlNode : object A W3C XML node.
Release Notes
1.0.1.03 Added "saveToXML" method to all objects
getElementById Returns a nested element matching the specified ID.
Returns: object
Parameters
id : string ID for the element.
getElementByTemplateId Returns a nested element having its "templateid" attribute equal to the specified ID.
Returns: object
Parameters
id : string The "templateid" of the element to search for.
Release Notes
1.0.1.02 Added method "getElementByTemplateId" to all elements
recurse Recursively applies a function to the element, to all its children, then to the children of each child and so on.
Parameters
start : object The root element to apply the function.
fn : object A function to be applied.
fireEvent Fires an event. All event handlers registered with addEventListener will be called to process the event.
Parameters
eventId : string ID that identifies the event.
eventObject : object An object containing data for the event.
addEventListener Adds an event listener to the element. The listener is a function that will be called whenever the event occurs.
Parameters
eventId : string ID that identifies the event.
handler : object Function to handle the event. This function may take one parameter: the Event object.
focus Attempts to bring the element into focus in the UI.
reapplyTemplate Forces the element to load its source feed again and apply the XSLT template. The local cache for the feed will be overwritten.
Release Notes
1.0.1.03 Added "reapplyTemplate" to all elements.

arrowscrollbox children

Release notes for arrowscrollbox

1.0.0.9 Added event "mouseover" to all elements
1.0.1.02 Added "templateid" attribute to all elements
1.0.1.02 Added method "getElementByTemplateId" to all elements
1.0.1.03 Added "saveToXML" method to all objects
1.0.1.03 Added "reapplyTemplate" to all elements.
1.0.1.05 Attributes set to persist will be synchronized between current instances of the toolbar.
1.0.1.05 Added two parameters to the XSL stylesheet: "toolbarId" and "applicationId". They contain the toolbar and application identifiers, respectively. By using these parameters, it is possible to write generic XSL transforms that will work on different toolbars.
1.0.1.05 Added "nonserialize" attribute to all elements.