Abstract superclass of model objects that are painted to screen.
| Method Summary |
|---|
| HTMLElement | gives focus to the on-screen VIEW for the element; returns a handle to the html/dhtml element as exposed by the native browser |
| Object<String, int> | Returns the absolute positioning of the object's on-screen view in relation to JSXROOT (whose left/top is 0/0). |
| String | Returns value for the custom attribute with the given name; returns null if no attribute found |
| Object<String, String> | Returns handle to the JavaScript Object Array containing all events for the JSX GUI object;
NOTE: This object will contain zero or more JavaScript Objects with the following Properties: script, type, system |
| String | Returns the value of the dynamic property @strPropName; if not found, returns null |
| HTMLElement | Returns handle/reference to the JSX GUI Object's on-screen counterpart—basically a handle to a DHTML object such as a DIV, SPAN, etc |
| jsx3.gui.Painted | Deprecated. Replaced with paintChild(). |
| protected void | A hook that subclasses of Painted may override in order to perform additional manipulation of the HTML DOM
created by the paint method. |
| abstract String | Returns the DHTML, used for this object's on-screen VIEW |
| void | Paints a child of this object without repainting this entire object. |
| String | Iterates through children and returns concatenation of paint() method for all children. |
| void | Removes the box model abstraction for a given object and its descendants. |
| jsx3.gui.Painted | removes the specific custom property bound to this object; returns a reference to self (this) to facilitate method chaining |
| jsx3.gui.Painted | removes all events bound to this object; NOTE: The object must still be painted/repainted for its corresponding on-screen view to be likewise updated; returns a reference to self (this) to facilitate method chaining |
| String | Updates the view of this object by calling paint() and replacing the current view with the
returned HTML. |
| jsx3.gui.Painted | Sets a property on the object that when the object is rendered on-screen, the HTML tag will be assigned the given name/value pair as a tag attribute |
| jsx3.gui.Painted | assigns a dynamic property to one of this object's properties
returns reference to self to facilitate method chaining; |
instance initializer
Parameters:
strName – unique name distinguishing this object from all other JSX GUI objects in the JSX application
gives focus to the on-screen VIEW for the element; returns a handle to the html/dhtml element as exposed by the native browser
Returns:
Returns the absolute positioning of the object's on-screen view in relation to JSXROOT (whose left/top is 0/0).
Returns information as a JavaScript object with properties, L, T, W, H
of @objRoot is null, the on-screen view for JSXROOT is used as the object reference
Parameters:
objRoot – object reference to IE DOM object (i.e., div, span, etc); if null is passed, the first div child of JSXROOT's on-screen representation will be used
objGUI – object reference to item to get absolute position for—as opposed to this instance (useful for determining placement of html objects contained by JSX objects, but not part of the actual JSX DOM)
Returns:
JScript object with properties: L, T, W, H (corresponding to left, top width, height)
Returns value for the custom attribute with the given name; returns null if no attribute found
Parameters:
strName – the name of the property/attribute
Returns:
Returns handle to the JavaScript Object Array containing all events for the JSX GUI object;
NOTE: This object will contain zero or more JavaScript Objects with the following Properties: script, type, system
Returns:
Returns the value of the dynamic property @strPropName; if not found, returns null
Parameters:
strName – property on this GUI object that will now use a dynamic property (e.g., 'jsxleft','jsxtop','jsxheight',etc.);
Returns:
value of the property
Returns handle/reference to the JSX GUI Object's on-screen counterpart—basically a handle to a DHTML object such as a DIV, SPAN, etc
Parameters:
objGUI – either the HTML document containing the rendered object or an HTML element in that document.
This argument is optional but improves the efficiency of this method if provided.
Returns:
IE DHTML object
Deprecated. Replaced with paintChild().
Paints a child of this object without repainting this entire object. The child is inserted into the view of
this object as the last child object, regardless of its actual position relative to other children. This method
has no effect if this object is not currently painted.
Parameters:
objChild – the child object to paint.
Returns:
this object.
See Also:
A hook that subclasses of Painted may override in order to perform additional manipulation of the HTML DOM
created by the paint method. The order of steps follows. All steps occur in a single browser thread so that
the screen does not update between steps 2 and 3.
- The paint() method of this object is called.
- The result of the paint() method is inserted into the HTML DOM.
- The onAfterPaint() method of this object is called, passing in the newly inserted root HTML element.
Parameters:
objGUI – the rendered HTML element representing this object.
Since:
3.4
Returns the DHTML, used for this object's on-screen VIEW
Returns:
DHTML
Paints a child of this object without repainting this entire object. The child is inserted into the view of
this object as the last child object, regardless of its actual position relative to other children. This method
has no effect if this object is not currently painted.
Parameters:
objChild – the child object to paint.
bGroup – true if this method is being called iteratively over a collection of
children. This parameter will only be false on the final call in the iteration.
objGUI –
bCascadeOnly –
Iterates through children and returns concatenation of paint() method for all children.
Parameters:
c – the children to paint. If not provided this.getChildren() is used.
Returns:
DHTML
Removes the box model abstraction for a given object and its descendants. This effectively resets the box profiler, so dimensions can be recalculated as if the object was just broought into the visual DOM.
Parameters:
properties – Will designate by name, those properties that should be updated on the object's VIEW (without requiring the MODEL to repaint), including one or more of the following: padding, margin, border
removes the specific custom property bound to this object; returns a reference to self (this) to facilitate method chaining
Parameters:
strName – the name of the custom property to remove
Returns:
this object
removes all events bound to this object; NOTE: The object must still be painted/repainted for its corresponding on-screen view to be likewise updated; returns a reference to self (this) to facilitate method chaining
Returns:
this object
Updates the view of this object by calling paint() and replacing the current view with the
returned HTML. This method has no effect if this object is not currently displayed.
Returns:
the result of calling paint() or null if this object is not displayed.
See Also:
Sets a property on the object that when the object is rendered on-screen, the HTML tag will be assigned the given name/value pair as a tag attribute
Parameters:
strName – the name of the property/attribute
strValue – the value for the property; may not contain double-quotes; escape via jsx3.util.strEscapeHTML if necessary or use combinations of single-quotes and escaped single-quotes
Returns:
this object (this)
assigns a dynamic property to one of this object's properties
returns reference to self to facilitate method chaining;
Parameters:
strName – property on this GUI object that will now use a dynamic property (e.g., 'jsxleft','jsxtop','jsxheight',etc.);
strValue – name of a dynamic style, whose value will be used
Returns:
this object
Copyright © 2001-2007, TIBCO Software Inc.