ZEN.Component.activeHGroup The active horizontal group is a client-side (JavaScript-heavy) container widget designed for creating binary partitions of an area of the active display. More...
Public Member Functions | |
installResizeHandlers () | |
Install or update the resize callbacks associated with this instance. | |
onRefreshContents () | |
This client event, if present, is fired when the page is loaded. | |
onloadHandler () | |
The code generated by the server is NOT the complete structure. More... | |
setProperty (property, value, value2) | |
Set the value of a named property. | |
![]() | |
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... | |
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... | |
![]() | |
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. | |
onPopupAction (popupName, action, value) | |
This client event, if present, is fired when a popup page has specified. 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... | |
startProgressBar (div) | |
Start the display of a progress bar within display. More... | |
stopProgressBar () | |
Stop the timer used by the Progress bar. | |
![]() | |
_.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... | |
renderContents () | |
This method, if present, is called when this component. More... | |
renderSVG (document, parent) | |
This method is only needed for SVG components. More... | |
![]() | |
_.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... | |
![]() | |
_.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 | |
autoExpand | |
If defined, this property indicates that one of the two panels. More... | |
handlePattern | |
This indicates a file name for an image to use for painting the. More... | |
handleThickness | |
This indicates the width of the pane partition handle in pixels. More... | |
noResize | |
if true, this indicates that the user is not to be allowed to More... | |
onresizeLeft | |
onresizeLeft event handler: More... | |
onresizeRight | |
onresizeRight event handler: More... | |
soundFX | |
This indicates a sound file to be played when an auto-expansion. More... | |
split | |
Defines the division between the two panes. More... | |
![]() | |
children | |
Set of components within this group. More... | |
disabled | |
If true, this group and its children are disabled. More... | |
![]() | |
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... | |
![]() | |
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 | |
DEFAULTENCLOSINGCLASS = None | |
ZEN.Component.activeHGroup The active horizontal group is a client-side (JavaScript-heavy) container widget designed for creating binary partitions of an area of the active display. More... | |
![]() | |
DEFAULTENCLOSINGCLASS = None | |
Subclasses can set this to change default css class for a group. | |
![]() | |
DEFAULTGROUPCLASS = None | |
Subclasses can set this to change default css class for a group. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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... | |
![]() | |
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 () | |
The HTML generated here is NOT the final DOM structure of this. More... | |
Additional Inherited Members | |
![]() | |
_.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... | |
ZEN.Component.activeHGroup The active horizontal group is a client-side (JavaScript-heavy) container widget designed for creating binary partitions of an area of the active display.
An activeHGroup is always specified with exactly two children (any excess are ignored). These children may have an arbitrary number of children of their own but at the top level the strict limit is enforced.
On the client-side, the component will be rendered as a split pane with left and right partitions, potentially separated by an adjustment handle. If no geometry restrictions are specified, the component will attempt to size itself to fill all available space remaining in the browser window (this behavior, can of course be overridden by CSS).
There are several properties governing the nature and handling of the partioning. The split may be speficied as an absolute reserve of pixels for the left or right pane (with excess pixels going to the other) or as a constant percentage to be reapportioned in actual pixels whenever the widget's container is resized. The split can be marked as either fixed or user-adjustable. It is possible specify child panes that slide open to a predefined wider width then the mouse rolls over them and auto-close when the mouse leaves the region. In the case of auto-expanding panes, it is possible to define sound effects to accompany the animation.
|
private |
The HTML generated here is NOT the final DOM structure of this.
component. At the client, the information embedded here will be used to build a more complex DOM subtree under the control of an active client-side layout manager. The exact structure of this expansion is not important for most users of this particular component, however, it is useful to not that the handle dividing the panes is of the HTML class zenHPaneHandle for the purposes of CSS style references.
Reimplemented from activeGroup.
onloadHandler | ( | ) |
The code generated by the server is NOT the complete structure.
for the activeHGroup. Like other client-side layout managers, only the necessary meta-data is sent to the client. The main processing logic is stored in a client-side, cache-able JavaScript file (zenActiveHGroup.js) To complete the connection between the meta-data description and the code library, the manager class must be registered with the generic client-side layout manager. The generic manager maintains a list of classes that require special handling and the JavaScript code bodies that perform such handling. A call to ZLM.initLayout() scans the DOM to find any meta-data classes (such as this one) and "unpacks" them into DOM structures for local geometry maintenance. This is all done behind the scenes via the Zen classes onload handler.
Reimplemented from activeGroup.
|
static |
ZEN.Component.activeHGroup The active horizontal group is a client-side (JavaScript-heavy) container widget designed for creating binary partitions of an area of the active display.
An activeHGroup is always specified with exactly two children (any excess are ignored). These children may have an arbitrary number of children of their own but at the top level the strict limit is enforced.
On the client-side, the component will be rendered as a split pane with left and right partitions, potentially separated by an adjustment handle. If no geometry restrictions are specified, the component will attempt to size itself to fill all available space remaining in the browser window (this behavior, can of course be overridden by CSS).
There are several properties governing the nature and handling of the partioning. The split may be speficied as an absolute reserve of pixels for the left or right pane (with excess pixels going to the other) or as a constant percentage to be reapportioned in actual pixels whenever the widget's container is resized. The split can be marked as either fixed or user-adjustable. It is possible specify child panes that slide open to a predefined wider width then the mouse rolls over them and auto-close when the mouse leaves the region. In the case of auto-expanding panes, it is possible to define sound effects to accompany the animation.
To be compatible with the static layout manager the enclosing class
has to be the generic activeGroup rather than the specific activeHGroup The activeHGroup is the one used for tuning attributes of the absolutely positioned elements.
autoExpand |
If defined, this property indicates that one of the two panels.
is an auto-open/auto-close sidebar panel and that the panel should expand when the mouse enters its "split"-defined bounds and grow until it reaches the width given in the autoExpand parameter. The value is always interpreted in pixels. A positive value designates the left pane for auto-expansion. A negative value designates the right.
The default value (null) indicates that the auto-expansion feature is not used by this instance of the widget.
handlePattern |
This indicates a file name for an image to use for painting the.
dragable partition handle. This image should be at least as wide as the handle thickness and is repeated vertically along the length of the handle.
The default value is a PNG file of a left-higlighted gray gradient, bounded by black on either side.
handleThickness |
This indicates the width of the pane partition handle in pixels.
Due to the dynamic functional nature of the element, the width of this bar cannot be set via CSS and must be specified via this property.
The default value is "7", resulting a drag handle a little under one eight of an inch (2 mm) wide on most screens.
noResize |
if true, this indicates that the user is not to be allowed to
resize the panes.
If false, user adjustment of the pane sizes is allowed via dragging the pane handle with the mouse. If user resizing is enabled, the mouse pointer will change to an east-west resize cursor when the mouse is in potential drag position.
The default value is "false"
onresizeLeft |
onresizeLeft event handler:
This event is fired when the left-hand panel of this component is resized
onresizeRight |
onresizeRight event handler:
This event is fired when the right-hand panel of this component is resized
soundFX |
This indicates a sound file to be played when an auto-expansion.
window grows or shrinks. If not defined or null, no sound accompanies the animation.
The default is "null"
split |
Defines the division between the two panes.
A value with a % sign is interpreted as a proportional division between the left and right panes and is recalculated to maintain this ratio whenever the base division is resized by any means.
Manual adjustment of the value continues to be interpreted as a percentage split.
A positive value not constaining a percent sign is interpreted as a fixed reserve width for the left child. Any adjustments to the total width of the base container are reflected in the geometry of the right pane only.
A negative value (which cannot contain a % sign) is interpreted as a fixed width for the right pane. Any adjustments to the total width of the base container are reflected in the geometry of the left child.
Manual adjustment of a left or right reserved width will change the size of the reserve and these fixed sizes will be respected even as the window is resized.
The default split is "50%"