This class provides a container-based, object-oriented approach to creating static html objects (basically this class creates "DIV" objects). This class is useful for creating objects as simple as 'labels' that can be placed anywhere on the screen. The advantage to using this class instead of trying to insert static html in the html window is that it allows the given HTML string to be managed by the 'container-management' strategy employed by the JSX Architecture
| Method Summary |
|---|
| String | Returns valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat; |
| String | Returns valid CSS property value, (e.g. |
| String | Returns CSS property value(s) for a border (border: solid 1px #000000) |
| String | Returns CSS text to override the standard instance properties on the painted object. |
| String | Returns the named CSS rule(s) to apply to the painted object. |
| String | Returns valid CSS property value, (e.g. |
| String | Returns valid CSS property value, (e.g. |
| Array<int> | Returns the dimensions in an array of four int values |
| String | Returns the CSS display for the object; one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;) |
| String | Returns the CSS font-family for the object |
| int | Returns the CSS font-size for the object |
| String | Returns the CSS font-weight for the object ("bold" or "normal") |
| int | String | Returns the height property of this object. |
| int | Returns IE tab index for setting the tabIndex property for the on-screen DHTML for the object |
| static jsx3.gui.Block | Deprecated. Use jsx3.html.getJSXParent() instead.
|
| int | String | Returns the left property of this object. |
| String | Returns CSS property value(s) for a margin (margin:4px;) |
| int | Returns the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height |
| String | Returns CSS property value(s) for a padding (padding:4px;) |
| int | Returns if the instance is relatively positioned on-screen; returns one of: jsx3.gui.Block.ABSOLUTE jsx3.gui.Block.RELATIVE |
| String | Returns HTML tag name to use when rendering the object on-screen (span is the default); if the property is null,
jsx3.gui.Block.DEFAULTTAGNAME is used; |
| String | Returns the text/HTML for the control to be displayed on-screen; returns an empty string if null; since the text
is rendered on-screen as browser-native HTML, the equivalent of an empty tag (e.g. |
| String | Returns the CSS text-align property for the object; if no property value exists, jsx3.gui.Block.ALIGNLEFT is returned by default |
| String | Returns the tooltip text to display when the object is hovered over. |
| int | String | Returns the top property of this object. |
| static String | |
| String | Returns the visibility property for the object |
| int | String | Returns the width property of this object. |
| int | Returns the CSS z-index property |
| void | removes the "blocking" mask inside the block to stop user interactions with existing content
|
| String | Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Block | Sets valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets valid CSS property value, (e.g. |
| jsx3.gui.Block | Sets CSS property value(s) for a border (border: solid 1px #000000). |
| jsx3.gui.Block | Sets CSS text to override the standard instance properties on the painted object. |
| jsx3.gui.Block | Sets the named CSS rule(s) to apply to the painted object. |
| jsx3.gui.Block | Sets valid CSS property value, (e.g. |
| void | Sets valid CSS property value, (e.g. |
| void | Set one to four dimensions at once. |
| jsx3.gui.Block | Sets the display for the object. |
| jsx3.gui.Block | Sets the CSS font-family for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the CSS font-size for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the CSS font-weight for the object ("bold" or "normal");
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the height property of this object. |
| jsx3.gui.Block | Sets IE tab index for setting the tabIndex property for the on-screen DHTML for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the left property of this object. |
| jsx3.gui.Block | Sets CSS property value for margin. |
| jsx3.gui.Block | Sets the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the CSS property value for padding an object. |
| jsx3.gui.Block | Sets if the jsx3.gui.Block instance is relatively positioned on-screen;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets HTML tag name to use when rendering the object on-screen (jsx3.gui.Block.DEFAULTTAGNAME is the default);
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the text/HTML for the control to be displayed on-screen;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the CSS text-align property for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the tooltip text to display when the object is hovered over. |
| jsx3.gui.Block | Sets the top property of this object. |
| void | Sets the CSS visibility property the object |
| jsx3.gui.Block | Sets the width property of this object. |
| void | Sets the CSS z-index for the object |
| void | displays a "blocking mask" inside the block to stop user interactions with content within the block. |
instance initializer
Parameters:
strName – unique name distinguishing this object from all other JSX GUI objects in the JSX application
vntLeft – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
vntTop – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
vntWidth – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
vntHeight – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
strHTML – Text/HTML markup to place in the jsx3.gui.Block instance
Returns valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
Returns:
valid CSS property for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
Returns valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
Returns:
valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
Returns CSS property value(s) for a border (border: solid 1px #000000)
Returns:
Returns CSS text to override the standard instance properties on the painted object.
Returns:
CSS text
Returns the named CSS rule(s) to apply to tdiv class="declaration">static
String DEFAULTFONTNAME
static
int DEFAULTFONTSIZE
static final
String DISPLAYBLOCK
static final
String DISPLAYNONE
static final
String FONTNORMAL
static final
int OVERFLOWEXPAND
static final
int OVERFLOWHIDDEN
static final
int OVERFLOWSCROLL
static final
int RELATIVE
static final
String VISIBILITYHIDDEN
static final
String VISIBILITYVISIBLE
instance initializer
Parameters:
strName – unique name distinguishing this object from all other JSX GUI objects in the JSX application
vntLeft – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
vntTop – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
vntWidth – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
vntHeight – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen
strHTML – Text/HTML markup to place in the jsx3.gui.Block instance
Returns valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
Returns:
valid CSS property for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
Returns valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
Returns:
valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
Returns CSS property value(s) for a border (border: solid 1px #000000)
Returns:
Returns CSS text to override the standard instance properties on the painted object.
Returns:
CSS text
Returns the named CSS rule(s) to apply to the painted object.
Returns:
Returns valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
Returns:
valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
Returns valid CSS property value, (e.g., default,wait,col-resize); if no value or an empty string, null is returned
Returns:
valid CSS property value, (e.g., default,wait,col-resize)
Returns the dimensions in an array of four int values
Returns:
[left,top,width,height]
Returns the CSS display for the object; one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;)
Returns:
String geetailcontent">
Returns valid CSS property value, (e.g., default,wait,col-resize); if no value or an empty string, null is returned
Returns:
valid CSS property value, (e.g., default,wait,col-resize)
Returns the dimensions in an array of four int values
Returns:
[left,top,width,height]
Returns the CSS display for the object; one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;)
Returns:
Returns the CSS font-family for the object
Returns:
valid CSS font-family property value
Returns the CSS font-size for the object
Returns:
font-size (in pixels)
Returns the CSS font-weight for the object ("bold" or "normal")
Returns:
[jsx3.gui.Block.FONTBOLD. jsx3.gui.Block.FONTNORMAL]
Returns the height property of this object.
Returns:
height.
Returns IE tab index for setting the tabIndex property for the on-screen DHTML for the object
Returns:
Deprecated. Use jsx3.html.getJSXParent() instead.
Returns the first JSX parent (as a JSX instance in the MODEL) of @objGUI (an HTML element in the VIEW); returns null if no jsx parent could be found
Parameters:
objGUI – HTML element in the VIEW from which to begin looking for the first containing JSX parent in the model
Returns:
JSX object
Returns the left property of this object.
Returns:
left.
Returns CSS property value(s) for a margin (margin:4px;)
Returns:
Returns the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height
Returns:
[jsx3.gui.Block.OVERFLOWSCROLL, jsx3.gui.Block.OVERFLOWHIDDEN, jsx3.gui.Block.OVERFLOWEXPAND]
Returns CSS property value(s) for a padding (padding:4px;)
Returns:
int getRelativePosition()
Returns if the instance is relatively positioned on-screen; returns one of: jsx3.gui.Block.ABSOLUTE jsx3.gui.Block.RELATIVE
Returns:
Returns HTML tag name to use when rendering the object on-screen (span is the default); if the property is null,
jsx3.gui.Block.DEFAULTTAGNAME is used;
Returns:
valid HTML tag name
Returns the text/HTML for the control to be displayed on-screen; returns an empty string if null; since the text
is rendered on-screen as browser-native HTML, the equivalent of an empty tag (e.g., <span\>) would be an
enclosing tag with an empty string (no content): <span></span>. To return null would be equivalent to
<span>null</span>, which is not the same as <span/>
Returns:
Returns the CSS text-align property for the object; if no property value exists, jsx3.gui.Block.ALIGNLEFT is returned by default
Returns:
one of: jsx3.gui.Block.ALIGNLEFT, jsx3.gui.Block.ALIGNRIGHT, jsx3.gui.Block.ALIGNCENTER
Returns the tooltip text to display when the object is hovered over. Returns an empty string if null.
Returns:
Returns the top property of this object.
Returns:
top.
Deprecated.
Returns the release/build for the class (i.e., "2.2.00")
Returns:
Returns the visibility property for the object
Returns:
[jsx3.gui.Block.VISIBILITYVISIBLE, jsx3.gui.Block.VISIBILITYHIDDEN]
Returns the width property of this object.
Returns:
width.
Returns the CSS z-index property
Returns:
void hideMask()
removes the "blocking" mask inside the block to stop user interactions with existing content
Returns the DHTML, used for this object's on-screen VIEW
Parameters:
strData – Text/HTML markup that will replace value of getText() during paint—typically passed by subclass, JSXBlockX after it performs an XML/XSL merge to acquire its data; for memory management purposes, the data is not set via setText() and, instead, is passed as a temporary input parameter, as the object's MODEL would contain the text for no reason
Returns:
DHTML
Overrides:
Sets valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
returns reference to self to facilitate method chaining;
Parameters:
strBG – valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
Returns:
this object
Sets valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0));
returns reference to self to facilitate method chaining;
Parameters:
strColor – valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object
Sets CSS property value(s) for a border (border: solid 1px #000000). Properties can be strung
together as in: border:solid 1px #989885;border-left-width:0px;
Parameters:
strCSS – valid CSS property value for a border (border: solid 1px #000000)
bRecalc – if true, the VIEW will be updated with requiring a repaint
Returns:
this object
Sets CSS text to override the standard instance properties on the painted object. Convenience method for extending this object. CSS properties affecting layout, including border-width, padding, margin, width, and height
are strongly discouraged, as they may interfere with the framework's internal box models.
Since some controls are composited from multiple HTML elements, some styles may not cascade to nested elements.
Instance Properties are the preferred method for applying styles.
Parameters:
strCSS – CSS text. Fore example, color:red;background-color:orange;
Returns:
this object
Sets the named CSS rule(s) to apply to the painted object. Rules that specify border-width, padding, margin, width, and height are strongly discouraged.
Multiple rules may be specified, delimited with a space. For example, label emphasis.
Since some controls are composited from multiple HTML elements, some rule styles may not cascade to nested elements.
Dynamic Properties are the preferred method for applying global styles.
Parameters:
strClassName – CSS property name without the leading "."
Returns:
this object
Sets valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0));
returns reference to self to facilitate method chaining;
Parameters:
strColor – valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object
Sets valid CSS property value, (e.g., default,wait,col-resize)
Parameters:
strCursor – valid CSS property value, (e.g., default,wait,col-resize)
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Set one to four dimensions at once. This operation is more efficient than calling more than one of
setLeft, setTop, etc. Any argument can be null to indicate not to update it.
Parameters:
left – the new left value or an array containing all four new values
top – the new top value
width – the new width value
height – the new height value
bRepaint â€pan class="jsxdoc_paramdesc">the new left value or an array containing all four new values
top – the new top value
width – the new width value
height – the new height value
bRepaint – whether to update the display of this object immediately. If left is
an Array then this parameter is the second parameter passed to this method.
Sets the display for the object. Note that although the framework uses CSS to apply this setting, the actual values that get set are determined by the system.
Only those parameters listed for @DISPLAY are supported as inputs to this function.
Parameters:
intDisplay – one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;)
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object
Sets the CSS font-family for the object;
returns reference to self to facilitate method chaining;
Parameters:
strFontName – valid CSS font-family property value
Returns:
this object
Sets the CSS font-size for the object;
returns reference to self to facilitate method chaining;
Parameters:
intPixelSize – font-size (in pixels)
Returns:
this object
Sets the CSS font-weight for the object ("bold" or "normal");
returns reference to self to facilitate method chaining;
Parameters:
FONTWEIGHT – [jsx3.gui.Block.FONTBOLD. jsx3.gui.Block.FONTNORMAL]
Returns:
this object
Sets the height property of this object.
Parameters:
vntHeight – the height as a non-negative integer or non-negative percentage. For example: 45%, 12.
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object.
Sets IE tab index for setting the tabIndex property for the on-screen DHTML for the object;
returns reference to self to facilitate method chaining;
Parameters:
intIndex – any value in the valid range of -32767 to 32767
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object
Sets the left property of this object. The left property specifies the horizontal offset of this object
from its parent and only applies if this object is absolutely positioned.
Parameters:
vntLeft – the left value. Only numeric values and percentages are supported. For example: 25, -10, 20%.
bRepaint – if @vntLeft is in integer (a number with no modifier) and @bRepaint is true, the object's on-screen VIEW is immediately updated to match its MODEL, obviating the need to call '[object].repaint()'
Returns:
this object.
Sets CSS property value for margin.
Parameters:
strCSS – The preferred method to set margin is by moving clockwise, beginning with the north
compass position, without the pixel designation. For example, to specify a top margin of 8 pixels, use 8 0 0 0. CSS syntax is
supported, but requires that pixels be designated. For example, using margin:5px;margin-left:10px;, is equivalent to
5 5 5 10.
bRecalc – if true, the VIEW will be updated with requiring a repaint
Returns:
this object
Sets the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height;
returns reference to self to facilitate method chaining;
Parameters:
OVERFLOW – [jsx3.gui.Block.OVERFLOWSCROLL, jsx3.gui.Block.OVERFLOWHIDDEN, jsx3.gui.Block.OVERFLOWEXPAND]
Returns:
this object
Sets the CSS property value for padding an object.
Parameters:
strCSS – The preferred method to set padding is by moving clockwise, beginning with the north
compass position, without the pixel designation. For example, to specify a top padding of 8 pixels, use 8 0 0 0. CSS syntax is
supported, but requires that pixels be designated. For example, using padding:5px;padding-left:10px;, is equivalent to
5 5 5 10.
bRecalc – if true, the VIEW will be updated with requiring a repaint
Returns:
this object
Sets if the jsx3.gui.Block instance is relatively positioned on-screen;
returns reference to self to facilitate method chaining;
Parameters:
intRelative – jsx3.gui.Block.RELATIVE will be applied to the view if null. One of: jsx3.gui.Block.RELATIVE jsx3.gui.Block.ABSOLUTE
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object
Sets HTML tag name to use when rendering the object on-screen (jsx3.gui.Block.DEFAULTTAGNAME is the default);
returns reference to self to facilitate method chaining;
Parameters:
strTagName – valid HTML tag name (span, div, form, ol, ul, li, etc); if null is passed, the getter will use jsx3.gui.Block.DEFAULTTAGNAME
Returns:
this object
Sets the text/HTML for the control to be displayed on-screen;
returns reference to self to facilitate method chaining;
Parameters:
strText – text/HTML
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
Sets the CSS text-align property for the object;
returns reference to self to facilitate method chaining;
Parameters:
ALIGN – one of: jsx3.gui.Block.ALIGNLEFT, jsx3.gui.Block.ALIGNRIGHT, jsx3.gui.Block.ALIGNCENTER
Returns:
Sets the tooltip text to display when the object is hovered over. Updates Model and View.
Returns reference to self to facilitate method chaining;
Parameters:
Returns:
this object
Sets the top property of this object. The top property specifies the vertical offset of this object
from its parent and only applies if this object is absolutely positioned.
Parameters:
vntTop – the top value. Only numeric values and percentages are supported. For example: 25, -10, 20%.
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object.
Sets the CSS visibility property the object
Parameters:
VISIBILITY – [jsx3.gui.Block.VISIBILITYVISIBLE, jsx3.gui.Block.VISIBILITYHIDDEN]
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Sets the CSS visibility property the object
Parameters:
VISIBILITY – [jsx3.gui.Block.VISIBILITYVISIBLE, jsx3.gui.Block.VISIBILITYHIDDEN]
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Sets the width property of this object.
Parameters:
vntWidth – the width as non-negative integer or non-negative percentage. For example: 45%, 12.
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
Returns:
this object.
Sets the CSS z-index for the object
Parameters:
intZIndex – z-index value
bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().
displays a "blocking mask" inside the block to stop user interactions with content within the block. Applies only to Blocks. Use only on blocks with no padding (padding:0px)
Parameters:
strMessage – text/message to display in the blocking mask to tell the user it is disabled
Copyright © 2001-2007, TIBCO Software Inc.