jsx3.gui.SliderAPI


Object
Object TypeThe JSX foundation class that this object is an instance of.
IDThe unique, system-assigned ID for this object.
NameSets the name assigned by the developer to identify this object.
Positioning
Relative XYSets whether to place this object relatively or absolutely with respect to its container.
LeftSets the position of this object from left edge of container.
TopSets the position of this object from top edge of container.
LengthSets the length of the slider.
Z-IndexIf this object is absolutely positioned, sets the CSS z-index.
Slider
OrientationSets the orientation of the slider, such as horizontal or vertical.
Handle ImageSets the URL of the image to use for the handle.
Show TrackSets whether to show the slider track.
Jump-To ClickSets whether clicking on the track moves the handle to that value.
EnabledSets whether or not the view for this item is enabled and mouse/keyboard events will be listened to.
ValueSets the value/content for the form control.
Box
BG ColorSets the background color.
Disabled BG ColorSets the background color to use when in a disabled state.
BackgroundSets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;.
MarginSets the gap between this object's border and its bounding box.
BorderSets the CSS border definition.
OverflowSets 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 OverrideConvenience method for extending this object.
DisplaySets the CSS display property.
VisibilitySets the CSS visibility property.
Interaction
Bound MenuSets the jsxname property for the context menu instance to display on a right-click.
Accessibility
Tab IndexSets the tab index.
TooltipSets the text displayed when hovered over this object (text only).
Metadata
Load TypeSets the load type of this DOM branch.
AnnotationThe annotation comment visible in the Component Hierarchy palette.
Help IDA unique ID for use with context-sensitive help.

Object Type

Read-Only. The JSX foundation class that this object is an instance of.

ID

Read-Only. The unique, system-assigned ID for this object.
Getter: getId()

Name

Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname

Relative XY

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:

Left

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

Top

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

Length

Sets the length of the slider. This value is applied as an implied pixel or a percentage. For example, 100 or 25%.
Default Value: 100
Getter: getLength()
Setter: setLength()
Property: jsxlength

Z-Index

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

Orientation

Sets the orientation of the slider, such as horizontal or vertical.
Default Value: Horizontal (jsx3.gui.Slider.HORIZONTAL)
Getter: getOrientation()
Setter: setOrientation()
Property: jsxorientation
Allowed Values:

Handle Image

Sets the URL of the image to use for the handle. If no URL is set, a default image is used.
Default Value: Default system-provided image
Getter: getHandleImage()
Setter: setHandleImage()
Property: jsximg

Show Track

Sets whether to show the slider track.
Default Value: Show (jsx3.Boolean.TRUE)
Getter: getPaintTrack()
Setter: setPaintTrack()
Property: jsxpainttrack
Allowed Values:

Jump-To Click

Sets whether clicking on the track moves the handle to that value.
Default Value: On (jsx3.Boolean.TRUE)
Getter: getTrackClickable()
Setter: setTrackClickable()
Property: jsxtrackclick
Allowed Values:

Enabled

Sets whether or not the view for this item is enabled and mouse/keyboard events will be listened to.
Default Value: Enabled (jsx3.gui.Form.STATEENABLED)
Getter: getEnabled()
Setter: setEnabled()
Property: jsxenabled
Allowed Values:

Value

Sets the value/content for the form control.
Getter: getValue()
Setter: setValue()
Property: jsxvalue

BG Color

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

Disabled BG Color

Sets the background color to use when in a disabled state. Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, For example, red, rgb(255,0,0), or #ff0000.
Default Value: The default disabled background color specified in the static field, DEFAULTDISABLEDBACKGROUNDCOLOR, of the component class. For example, jsx3.gui.Form.DEFAULTDISABLEDBACKGROUNDCOLOR. See the API documentation for the component.
Getter: getDisabledBackgroundColor()
Setter: setDisabledBackgroundColor()
Property: jsxdisabledbgcolor

Background

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

Margin

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

Border

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

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.
Default Value: Expand (jsx3.gui.Block.OVERFLOWEXPAND)
Getter: getOverflow()
Setter: setOverflow()
Property: jsxoverflow
Allowed Values:

CSS Override

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

Display

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:

Visibility

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:

Bound Menu

Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu

Tab Index

Sets the tab index. When tabbing between controls, the index group this component belongs to.
Default Value: Empty
Getter: getIndex()
Setter: setIndex()
Property: jsxindex

Tooltip

Sets the text displayed when hovered over this object (text only).
Default Value: Empty
Getter: getTip()
Setter: setTip()
Property: jsxtip

Load Type

Sets the load type of this DOM branch.
Default Value: Normal (jsx3.app.Model.LT_NORMAL)
Getter: getLoadType()
Setter: setLoadType()
Property: jsxloadtype
Allowed Values:

Annotation

The annotation comment visible in the Component Hierarchy palette.
Property: jsxannotation

Help ID

A unique ID for use with context-sensitive help.
Getter: getHelpId()
Setter: setHelpId()
Property: jsxhelpid