jsx3.gui.BlockXAPI
| Object |
|---|
| Object Type | The JSX foundation class that this object is an instance of. |
| ID | The unique, system-assigned ID for this object. |
| Name | Sets the name assigned by the developer to identify this object. |
| Positioning |
|---|
| Relative XY | Sets whether to place this object relatively or absolutely with respect to its container. |
| Left | Sets the position of this object from left edge of container. |
| Top | Sets the position of this object from top edge of container. |
| Width | Sets the width of the control as implied pixels or a percentage. |
| Height | Sets the height of the control in pixels or percentage. |
| Z-Index | If this object is absolutely positioned, sets the CSS z-index. |
| BlockX |
|---|
| Tag Name | Sets the HTML tag to use when rendering this object on-screen. |
| XML/XSL |
|---|
| XML Cache Id | Sets the cache ID for the XML document this object is mapped to. |
| XML String | Sets an XML document as a string. |
| XML URL | Sets the URL for the resource. |
| XML Transformers | A comma-separated list of XSLT transformers. |
| Share Resources | If set to Share, this object does not delete its associated document from the cache when removed from the DOM. |
| XML Async | If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads. |
| XML Bind | If set to Bound this control automatically repaints every time its XML cache document changes. |
| Font |
|---|
| Font Name | Sets the name of the font family. |
| Font Size | Sets the point size of the font. |
| Font Weight | Sets the weight of the font, such as bold or normal. |
| Color | Sets the color of the font. |
| Box |
|---|
| BG Color | Sets the background color. |
| Background | Sets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;. |
| Padding | Sets the white-space gap between the outer edge/border of this object to its inner content. |
| Margin | Sets the gap between this object's border and its bounding box. |
| Border | Sets the CSS border definition. |
| Text Align | Sets the alignment of any contained object or text. |
| Overflow | Sets the CSS overflow for this object, which defines how its on-screen view behaves when the contents are larger than the specified width and/or height. |
| CSS |
|---|
| CSS Override | Convenience method for extending this object. |
| CSS Rule Name | Sets the named CSS rule(s) to use. |
| Display | Sets the CSS display property. |
| Visibility | Sets the CSS visibility property. |
| Interaction |
|---|
| Cursor | Sets the CSS cursor definition, such as default, wait, or col-resize. |
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
| Accessibility |
|---|
| Tab Index | Sets the tab index. |
| Tooltip | Sets the text displayed when hovered over this object (text only). |
| Metadata |
|---|
| Load Type | Sets the load type of this DOM branch. |
| Annotation | The annotation comment visible in the Component Hierarchy palette. |
| Help ID | A unique ID for use with context-sensitive help. |
Read-Only. The JSX foundation class that this object is an instance of.
Read-Only. The unique, system-assigned ID for this object.
Getter: getId()
Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname
Sets whether to place this object relatively or absolutely with respect to its container.
Default Value: Relative (jsx3.gui.Block.RELATIVE)
Getter: getRelativePosition()
Setter: setRelativePosition()
Property: jsxrelativeposition
Allowed Values: - Absolute (
jsx3.gui.Block.ABSOLUTE) - Relative (
jsx3.gui.Block.RELATIVE)
Sets the position of this object from left edge of container. If this object is absolutely positioned, this value is applied as an implied pixel or a percentage. For example, 10 or 15%.
Default Value: If absolutely positioned, the default is 0. If relatively positioned, the default is empty.
Getter: getLeft()
Setter: setLeft()
Property: jsxleft
Sets the position of this object from top edge of container. If this object is absolutely positioned, this value is applied as an implied pixel or a percentage. For example, 10 or 15%.
Default Value: If absolutely positioned, the default is 0. If relatively positioned, the default is empty.
Getter: getTop()
Setter: setTop()
Property: jsxtop
Sets the width of the control as implied pixels or a percentage. For example, 100 or 25%.
Default Value: Empty
Getter: getWidth()
Setter: setWidth()
Property: jsxwidth
Sets the height of the control in pixels or percentage. For example, 100 or 25%.
Default Value: Empty
Getter: getHeight()
Setter: setHeight()
Property: jsxheight
If this object is absolutely positioned, sets the CSS z-index. The z-index sets the stack order of an element.
Default Value: 1
Getter: getZIndex()
Setter: setZIndex()
Property: jsxzindex
Sets the HTML tag to use when rendering this object on-screen.
Default Value: span
Getter: getTagName()
Setter: setTagName()
Property: jsxtagname
Sets the cache ID for the XML document this object is mapped to.
Default Value: Unique ID assigned by the system
Getter: getXMLId()
Setter: setXMLId()
Property: jsxxmlid
Sets an XML document as a string.
Getter: getXMLString()
Setter: setXMLString()
Property: jsxxml
Sets the URL for the resource. This resource is synchronously loaded when this object is painted on-screen.
Getter: getXMLURL()
Setter: setXMLURL()
Property: jsxxmlurl
A comma-separated list of XSLT transformers. The source XML will be transformed in series by each of the transformers listed here before being placed in the XML cache. Each transformer is either a URI to an XSLT file or the XML cache id of an XSLT document.
Getter: getXMLTransformers()
Setter: setXMLTransformers()
Property: jsxxmltrans
If set to Share, this object does not delete its associated document from the cache when removed from the DOM.
Default Value: Cleanup (jsx3.xml.Cacheable.CLEANUPRESOURCES)
Getter: getShareResources()
Setter: setShareResources()
Property: jsxshare
Allowed Values: - Cleanup (
jsx3.xml.Cacheable.CLEANUPRESOURCES) - Share (
jsx3.xml.Cacheable.SHARERESOURCES)
If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads.
Default Value: Synchronous (jsx3.Boolean.FALSE)
Getter: getXmlAsync()
Setter: setXmlAsync()
Property: jsxxmlasync
Allowed Values: - Asynchronous (
jsx3.Boolean.TRUE) - Synchronous (
jsx3.Boolean.FALSE)
If set to Bound this control automatically repaints every time its XML cache document changes.
Default Value: Not Bound (jsx3.Boolean.FALSE)
Getter: getXmlBind()
Setter: setXmlBind()
Property: jsxxmlbind
Allowed Values: - Bound (
jsx3.Boolean.TRUE) - Not Bound (
jsx3.Boolean.FALSE)
Sets the name of the font family.
Default Value: jsx3.gui.Block.DEFAULTFONTNAME
Getter: getFontName()
Setter: setFontName()
Property: jsxfontname
Sets the point size of the font.
Default Value: jsx3.gui.Block.DEFAULTFONTSIZE
Getter: getFontSize()
Setter: setFontSize()
Property: jsxfontsize
Sets the weight of the font, such as bold or normal.
Default Value: Normal (jsx3.gui.Block.FONTNORMAL)
Getter: getFontWeight()
Setter: setFontWeight()
Property: jsxfontweight
Allowed Values: - Bold (
jsx3.gui.Block.FONTBOLD) - Normal (
jsx3.gui.Block.FONTNORMAL)
Sets the color of the font. Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: jsx3.gui.Block.DEFAULTCOLOR
Getter: getColor()
Setter: setColor()
Property: jsxcolor
Sets the background color. Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: The default background color specified in the static field, DEFAULTBACKGROUNDCOLOR, of the component class. For example, the default background color for a list is #f3f2f4 and is specified in jsx3.gui.List.DEFAULTBACKGROUNDCOLOR. See the API documentation for the component. For some components, this property is empty.
Getter: getBackgroundColor()
Setter: setBackgroundColor()
Property: jsxbgcolor
Sets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;.
Default Value: Empty
Getter: getBackground()
Setter: setBackground()
Property: jsxbg
Sets the white-space gap between the outer edge/border of this object to its inner content. Specified as one or four pixel values (top, right, bottom, and left). For example, 5 or 8 4 8 4.
Default Value: Empty
Getter: getPadding()
Setter: setPadding()
Property: jsxpadding
Sets the gap between this object's border and its bounding box. Specified as one or four pixel values (top, right, bottom, and left). For example, 2 or 4 2 4 2. CSS syntax is also supported but reduces performance.
Default Value: Empty
Getter: getMargin()
Setter: setMargin()
Property: jsxmargin
Sets the CSS border definition. Specified as one or four value sets (top, right, bottom, and left). Specified as: style width color. For example, solid 1px red;dashed 2px red;double 3px black; solid 1px red;.
Default Value: Empty
Getter: getBorder()
Setter: setBorder()
Property: jsxborder
Sets the alignment of any contained object or text.
Default Value: Left (jsx3.gui.Block.ALIGNLEFT)
Getter: <code>getTextAlign</code>()
Setter: setTextAlign()
Property: jsxtextalign
Allowed Values: - Left (
jsx3.gui.Block.ALIGNLEFT) - Center (
jsx3.gui.Block.ALIGNCENTER) - Right (
jsx3.gui.Block.ALIGNRIGHT)
Sets the CSS overflow for this object, which defines how its on-screen view behaves when the contents are larger than the specified width and/or height.
Default Value: Expand (jsx3.gui.Block.OVERFLOWEXPAND)
Getter: getOverflow()
Setter: setOverflow()
Property: jsxoverflow
Allowed Values: - Scroll (
jsx3.gui.Block.OVERFLOWSCROLL) - Hidden (
jsx3.gui.Block.OVERFLOWHIDDEN) - Expand (
jsx3.gui.Block.OVERFLOWEXPAND)
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.
Getter: getCSSOverride()
Setter: setCSSOverride()
Property: jsxstyleoverride
Sets the named CSS rule(s) to use. 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.
Getter: getClassName()
Setter: setClassName()
Property: jsxclassname
Sets the CSS display property. When set to None, content is hidden AND the container collapses.
Default Value: Block (jsx3.gui.Block.DISPLAYBLOCK)
Getter: getDisplay()
Setter: setDisplay()
Property: jsxdisplay
Allowed Values: - Block (
jsx3.gui.Block.DISPLAYBLOCK) - None (
jsx3.gui.Block.DISPLAYNONE)
Sets the CSS visibility property. When set to Hidden, content is hidden.
Default Value: Visible (jsx3.gui.Block.VISIBILITYVISIBLE)
Getter: getVisibility()
Setter: setVisibility()
Property: jsxvisibility
Allowed Values: - Visible (
jsx3.gui.Block.VISIBILITYVISIBLE) - Hidden (
jsx3.gui.Block.VISIBILITYHIDDEN)
Sets the CSS cursor definition, such as default, wait, or col-resize.
Default Value: Empty
Getter: getCursor()
Setter: setCursor()
Property: jsxcursor
Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu
Sets the tab index. When tabbing between controls, the index group this component belongs to.
Default Value: Empty
Getter: getIndex()
Setter: setIndex()
Property: jsxindex
Sets the text displayed when hovered over this object (text only).
Default Value: Empty
Getter: getTip()
Setter: setTip()
Property: jsxtip
Sets the load type of this DOM branch.
Default Value: Normal (jsx3.app.Model.LT_NORMAL)
Getter: getLoadType()
Setter: setLoadType()
Property: jsxloadtype
Allowed Values: - Normal (
jsx3.app.Model.LT_NORMAL) - Paint Async. (
jsx3.app.Model.LT_SLEEP_PAINT) - Deserialize Async. (
jsx3.app.Model.LT_SLEEP_DESER) - Paint & Deser. Async. (
jsx3.app.Model.LT_SLEEP_PD) - Paint on Show (
jsx3.app.Model.LT_SHOW_PAINT) - Deserialize on Show (
jsx3.app.Model.LT_SHOW_DESER)
The annotation comment visible in the Component Hierarchy palette.
Property: jsxannotation
A unique ID for use with context-sensitive help.
Getter: getHelpId()
Setter: setHelpId()
Property: jsxhelpid
Copyright © 2001-2007, TIBCO Software Inc.