jsx3.gui

class Splitter

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.gui.Splitter

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class Splitter
extends jsx3.gui.Block

This class manages layouts by providing a container that will paint its first two child GUI objects separated by a 'splitter' (either vertical or horizontal). Split panes can contain any number of object types, but most commonly contain JSXBlock elements to aid in layout feautures such as padding, borders, etc.

Field Summary
static int	ORIENTATIONH
static int	ORIENTATIONV

Constructor Summary
void	init(strName : String, ORIENTATION : int) instance initializer

Method Summary
int	getEnabled() Returns whether the user can resize this control
String	getHSplitImage() Returns the URL for the image to use for the splitter handle when the splitter is rendered side by side ( \| ).
int	getOrientation() *Returns whether the splitter layout is top-over (--) or side-by-side (\|).
int	getSubcontainer1Min() Returns a valid integer representing the minimum size in pixels for the container; the default minimum is 1
String	getSubcontainer1Pct() Returns a valid percentage (e.g.
int	getSubcontainer2Min() Returns a valid integer representing the minimum size in pixels for the container; the default minimum is 8
String	getVSplitImage() Returns the URL for the image to use for the splitter handle when the splitter is rendered top over bottom (--).
static String	getVersion() Deprecated.
String	paint() Returns the DHTML, used for this object's on-screen VIEW
jsx3.gui.Splitter	paintChild(objJSXChild : jsx3.app.Model, bGroup : ?) subclassed method.
void	setEnabled(intEnabled : int) Sets whether the user can resize this control.
jsx3.gui.Splitter	setHSplitImage(strURL : String) Sets the URL for the image to use for the splitter handle when the splitter is rendered side by side ( \| ).
jsx3.gui.Splitter	setOrientation(ORIENTATION : int) Returns whether the splitter layout is top-over (--) or side-by-side (\|); returns reference to self to facilitate method chaining
jsx3.gui.Splitter	setSubcontainer1Min(intMin : int) Sets the minimum size in pixels for the container; the default minimum is 1; returns reference to self to facilitate method chaining
jsx3.gui.Splitter	setSubcontainer1Pct(strSubcontainerPct : String, bView : boolean) Sets a valid percentage (e.g.
jsx3.gui.Splitter	setSubcontainer2Min(intMin : int) Sets the minimum size in pixels for the container; the default minimum is 8; returns reference to self to facilitate method chaining
jsx3.gui.Splitter	setVSplitImage(strURL : String) Sets the URL for the image to use for the splitter handle when the splitter is rendered top over bottom (--).

Methods Inherited From jsx3.gui.Block
getBackground, getBackgroundColor, getBorder, getCDFAttribute, getCDFId, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, setBackground, setBackgroundColor, setBorder, setCDFAttribute, setCDFId, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCDFAttribute, getCDFId, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, setBackground, setBackgroundColor, setBorder, setCDFAttribute, setCDFId, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute

Methods Inherited From jsx3.app.Model
adoptChild, assembleFromXML, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getDynamicProperty, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onChildAdded, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, selectDescendants, setChild, setDynamicProperty, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc, toXMLElm

Methods Inherited From jsx3.app.Model

adoptChild, assembleFromXML, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getDynamicProperty, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onChildAdded, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, selectDescendants, setChild, setDynamicProperty, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc, toXMLElm

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf

Field Detail

ORIENTATIONH

static final int ORIENTATIONH

ORIENTATIONV

static final int ORIENTATIONV

Constructor Detail

init

void init(strName : String, ORIENTATION : int)

instance initializer

Parameters:

strName – unique name distinguishing this object from all other JSX GUI objects in the JSX application

ORIENTATION – constant; either jsx3.gui.Splitter.ORIENTATIONH or jsx3.gui.Splitter.ORIENTATIONV; if none provided the default (horizontal layout) or vertical (stacked) layout)

Method Detail

getEnabled

int getEnabled()

Returns whether the user can resize this control

Returns:

0, 1, or null

getHSplitImage

String getHSplitImage()

Returns the URL for the image to use for the splitter handle when the splitter is rendered side by side ( | ). When not set, Splitter.HSPLITIMAGE will be used when painted on-screen.

Returns:

getOrientation

int getOrientation()

*Returns whether the splitter layout is top-over (--) or side-by-side (|).

Returns:

getSubcontainer1Min

int getSubcontainer1Min()

Returns a valid integer representing the minimum size in pixels for the container; the default minimum is 1

Returns:

getSubcontainer1Pct

String getSubcontainer1Pct()

Returns a valid percentage (e.g., 100.00% 23.567%) that will be applied to the on-screen element as its CSS width/height percentage

Returns:

getSubcontainer2Min

int getSubcontainer2Min()

Returns a valid integer representing the minimum size in pixels for the container; the default minimum is 8

Returns:

getVSplitImage

String getVSplitImage()

Returns the URL for the image to use for the splitter handle when the splitter is rendered top over bottom (--). When not set, Splitter.VSPLITIMAGE will be used when painted on-screen.

Returns:

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00")

Returns:

paint

String paint()

Returns the DHTML, used for this object's on-screen VIEW

Returns:

DHTML

Overrides:

paint in jsx3.gui.Block

paintChild

jsx3.gui.Splitter paintChild(objJSXChild : jsx3.app.Model, bGroup : ?)

subclassed method. routes call to repaint() as splitters cannot insert directly into the DOM

Parameters:

objJSXChild – direct child whose generated VIEW will be directly inserted into the DOM to provide more efficient screen updates as repaint is costly for large applications

bGroup –

Returns:

this object

Overrides:

paintChild in jsx3.gui.Painted

setEnabled

void setEnabled(intEnabled : int)

Sets whether the user can resize this control.

Parameters:

intEnabled – 0 or 1. Note: null is equivalent to 1.

setHSplitImage

jsx3.gui.Splitter setHSplitImage(strURL : String)

Sets the URL for the image to use for the splitter handle when the splitter is rendered side by side ( | ).

Parameters:

strURL – valid URL. If no background image is wanted, pass an empty string. The resize bar for a side-by-side orientation is 8 pixels wide with a variable height; the image will be placed at background position, 'center center', and will not repeat.

Returns:

this object

setOrientation

jsx3.gui.Splitter setOrientation(ORIENTATION : int)

Returns whether the splitter layout is top-over (--) or side-by-side (|); returns reference to self to facilitate method chaining

Parameters:

ORIENTATION – constant; either jsx3.gui.Splitter.ORIENTATIONH or jsx3.gui.Splitter.ORIENTATIONV

Returns:

this object

setSubcontainer1Min

jsx3.gui.Splitter setSubcontainer1Min(intMin : int)

Sets the minimum size in pixels for the container; the default minimum is 1; returns reference to self to facilitate method chaining

Parameters:

intMin – integer value represnting the minimum size in pixels for the container

Returns:

this object

setSubcontainer1Pct

jsx3.gui.Splitter setSubcontainer1Pct(strSubcontainerPct : String, bView : boolean)

Sets a valid percentage (e.g., 100% 23.567%) that will be applied to the on-screen element as its CSS width/height percentage. If pixels are the preferred unit, you may use an integer and a wild card (*) to apply the value to either container. For example, 100,* or *,250.

Parameters:

strSubcontainerPct – valid CSS width property as a percentage (e.g., 34.56%) or as an integer/wildcard pair (e.g., 100,*)

bView – false if null; if true the view is updated automatically without a repaint

Returns:

this object

setSubcontainer2Min

jsx3.gui.Splitter setSubcontainer2Min(intMin : int)

Sets the minimum size in pixels for the container; the default minimum is 8; returns reference to self to facilitate method chaining

Parameters:

intMin – integer value represnting the minimum size in pixels for the container

Returns:

this object

setVSplitImage

jsx3.gui.Splitter setVSplitImage(strURL : String)

Sets the URL for the image to use for the splitter handle when the splitter is rendered top over bottom (--).

Parameters:

strURL – valid URL. If no background image is wanted, pass an empty string. The resize bar for a top-over-bottom orientation is 8 pixels hight with a variable width; the image will be placed at background position, 'center center', and will not repeat.

Returns:

this object