jsx3.gui.DialogAPI
| 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 |
|---|
| Left | Sets the distance from left edge of container in pixels. |
| Top | Sets the distance from top edge of container in pixels. |
| Width | Sets width of this dialog in pixels. |
| Height | Sets height of this dialog in pixels. |
| Resize |
|---|
| Resizable | Determines if the dialog can be resized by the user at runtime. |
| Min Width | Sets the minimum width of the dialog when resized. |
| Min Height | Sets the minimum height of the dialog when resized. |
| Max Width | Sets the maximum width of the dialog when resized. |
| Max Height | Sets the maximum height of the dialog when resized. |
| Dialog |
|---|
| Modal | Sets whether this Dialog is modal. |
| State | Sets the window state to full-sized (Maximized) or window-shaded (Minimized). |
| Z Multiplier | Sets the number to multiply the z-index for this dialog to give it precedence (dialogs index in the 5000 range). |
| Box |
|---|
| BG Color | Sets the background color. |
| Background | Sets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;. |
| 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. |
| Display | Sets the CSS display property. |
| Visibility | Sets the CSS visibility property. |
| 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 the distance from left edge of container in pixels. The unit (px) is implied and should not be entered.
Default Value: Centered in the parent container
Getter: getLeft()
Setter: setLeft()
Property: jsxleft
Sets the distance from top edge of container in pixels. The unit (px) is implied and should not be entered.
Default Value: Centered in the parent container
Getter: getTop()
Setter: setTop()
Property: jsxtop
Sets width of this dialog in pixels. The unit (px) is implied and should not be entered.
Default Value: No default, must specify
Getter: getWidth()
Setter: setWidth()
Property: jsxwidth
Sets height of this dialog in pixels. The unit (px) is implied and should not be entered.
Default Value: No default, must specify
Getter: getHeight()
Setter: setHeight()
Property: jsxheight
Determines if the dialog can be resized by the user at runtime.
Default Value: Resizable (jsx3.Boolean.TRUE)
Getter: getResizable()
Setter: setResizable()
Property: jsxresize
Allowed Values: - Resizable (
jsx3.Boolean.TRUE) - Fixed (
jsx3.Boolean.FALSE)
Sets the minimum width of the dialog when resized. Units are implied pixels and only positive integers are allowed.
Setter: setResizeParameters()
Property: jsxminx
Sets the minimum height of the dialog when resized. Units are implied pixels and only positive integers are allowed.
Setter: setResizeParameters()
Property: jsxminy
Sets the maximum width of the dialog when resized. Units are implied pixels and only positive integers are allowed.
Setter: setResizeParameters()
Property: jsxmaxx
Sets the maximum height of the dialog when resized. Units are implied pixels and only positive integers are allowed.
Setter: setResizeParameters()
Property: jsxmaxy
Sets whether this Dialog is modal. Modal dialogs mask the rest of the container with a semi-transparent mask that blocks mouse interaction. Modal dialogs do not show up in the taskbar.
Default Value: None (jsx3.gui.Dialog.NONMODAL)
Getter: getModal()
Setter: setModal()
Property: jsxmodal
Allowed Values: - Default/None (
jsx3.gui.Dialog.NONMODAL) - Modal (
jsx3.gui.Dialog.MODAL)
Sets the window state to full-sized (Maximized) or window-shaded (Minimized).
Default Value: Maximized (jsx3.gui.Dialog.MAXIMIZED)
Getter: getWindowState()
Setter: setWindowState()
Property: jsxwindowstate
Allowed Values: - Maximized (
jsx3.gui.Dialog.MAXIMIZED) - Minimized (
jsx3.gui.Dialog.MINIMIZED)
Sets the number to multiply the z-index for this dialog to give it precedence (dialogs index in the 5000 range). If a dialog needs to always be on top of other dialog instances, this multiplier can be increased to assure the appropriate z-index. For example, a value of 5 would stack this dialog on top of all dialogs with an alwaysOnTop multiplier less than 5.
Default Value: 1
Getter: getZMultiplier()
Setter: setZMultiplier()
Property: jsxzmultiplier
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 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 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 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.