OverviewSingleDeprecated

jsx3.gui

class LayoutGrid

Object
->jsx3.lang.Object
  ->jsx3.app.Model
    ->jsx3.gui.Painted
      ->jsx3.gui.Block
        ->jsx3.gui.LayoutGrid

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

Direct Known Subclasses:

jsx3.gui.StackGroup
class LayoutGrid
extends jsx3.gui.Block
This class provides a way to organize a set of GUI objects in a grid. The dimensions of each cell in the grid are determined by the row heights and column widths. The height of each row and width of each column may be defined either as a percent, an integer pixel value, or as "*". Each dimension may specify one or more divisions as "*", in which case these rows/columns share the remaining space in that dimension equally once the other rows/columns are fitted.

GUI objects that are children of this DOM node are rendered in the cells. The first child is rendered in the top-left corner. Subsequent children are rendered in rows from left to right and top to bottom.
Field Summary
static int
ABSOLUTE
Deprecated.
static int
ADAPTIVE
Deprecated.
static Array<String>
DEFAULTDIMENSIONS
Deprecated.
static int
DEFAULTORIENTATION
Deprecated.
static int
DEFAULTREPEAT
Deprecated.
static int
ORIENTATIONCOL
Deprecated.
static int
ORIENTATIONROW
Deprecated.
Constructor Summary
void
init(strName : String)
The instance initializer.
Method Summary
int
getBestGuess()
Deprecated.
String
getCols()
Array<int | String>
getDimensionArray()
Deprecated. Use getRows() and getCols() instead.
int
getOrientation()
Deprecated. Use getRows() and getCols() instead.
int
getRepeat()
Deprecated.
String
getRows()
static String
getVersion()
Deprecated.
String
paint()
Returns the DHTML, used for this object's on-screen VIEW
jsx3.gui.LayoutGrid
setBestGuess(LAYOUT : int)
Deprecated.
jsx3.gui.LayoutGrid
setCols(strCols : String, bRepaint : ?)
jsx3.gui.LayoutGrid
setDimensionArray(objArray : Array<int | String>, bRepaint : boolean)
Deprecated. Use setRows() and setCols() instead.
jsx3.gui.LayoutGrid
setOrientation(ORIENTATION : int)
Deprecated. Use setRows() and setCols() instead.
jsx3.gui.LayoutGrid
setRepeat(intCellCount : int)
Deprecated.
jsx3.gui.LayoutGrid
setRows(strRows : String, bRepaint : ?)
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, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty
Methods Inherited From jsx3.app.Model
adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc
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

ABSOLUTE

static int ABSOLUTE
Deprecated.
0

ADAPTIVE

static int ADAPTIVE
Deprecated.
1

DEFAULTDIMENSIONS

static Array<String> DEFAULTDIMENSIONS
Deprecated.
["33%","33%","34%"] (default)

DEFAULTORIENTATION

static int DEFAULTORIENTATION
Deprecated.
0 : top-over (--) layout (default)

DEFAULTREPEAT

static int DEFAULTREPEAT
Deprecated.
3 (default)

ORIENTATIONCOL

static int ORIENTATIONCOL
Deprecated.
0 : top-over (--) layout

ORIENTATIONROW

static int ORIENTATIONROW
Deprecated.
1 : side-by-side (|) layout
Constructor Detail

init

void init(strName : String)
The instance initializer.

Parameters:

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

getBestGuess

int getBestGuess()
Deprecated.
The LayoutGrid leverages an HTML Table for its on-screen VIEW; this table can use the browser's own adaptive layouts to best adjust to the size of its content; returns one of: jsx3.gui.LayoutGrid.ABSOLUTE, jsx3.gui.LayoutGrid.ADAPTIVE

Returns:

one of: jsx3.gui.LayoutGrid.ABSOLUTE, jsx3.gui.LayoutGrid.ADAPTIVE 

getCols

String getCols()

Returns:

 

Since:

3.4

getDimensionArray

Array<int | String> getDimensionArray()
Deprecated. Use getRows() and getCols() instead.
Returns dimensions for cells in the layoutgrid as a JavaScript array

Returns:

JavaScript array 

getOrientation

int getOrientation()
Deprecated. Use getRows() and getCols() instead.
Returns whether the layout grid will render items top-over (--) or side-by-side (|); returns jsx3.gui.LayoutGrid.ORIENTATIONCOL or jsx3.gui.LayoutGrid.ORIENTATIONROW

Returns:

 

getRepeat

int getRepeat()
Deprecated.
Returns the number of cells to draw before starting a new row/column of cells

Returns:

number of cells to draw before starting a new row/column of cells 

getRows

String getRows()

Returns:

 

Since:

3.4

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

setBestGuess

jsx3.gui.LayoutGrid setBestGuess(LAYOUT : int)
Deprecated.
The LayoutGrid leverages an HTML Table for its on-screen VIEW; this table can use the browser's own adaptive layouts to best adjust to the size of its content; returns one of: jsx3.gui.LayoutGrid.ABSOLUTE, jsx3.gui.LayoutGrid.ADAPTIVE; returns reference to self to facilitate method chaining

Parameters:

LAYOUT – jsx3.gui.LayoutGrid.ABSOLUTE if null; one of: jsx3.gui.LayoutGrid.ABSOLUTE, jsx3.gui.LayoutGrid.ADAPTIVE

Returns:

this object 

setCols

jsx3.gui.LayoutGrid setCols(strCols : String, bRepaint : ?)

Parameters:

strCols –
bRepaint –

Returns:

this object. 

Since:

3.4

setDimensionArray

jsx3.gui.LayoutGrid setDimensionArray(objArray : Array<int | String>, bRepaint : boolean)
Deprecated. Use setRows() and setCols() instead.
Sets dimensions for cells in the layoutgrid; returns reference to self to facilitate method chaining

Parameters:

objArray – if null, no sizing information will be applied to the cells; otherwise: valid JavaScript array with number of items equal to the value of this.getRepeat();
bRepaint – false if null; if true, the new dimensions will be applied to the on-screen view without a repaint, allowing for faster performance than by following this call with a repaint() call

Returns:

this object 

setOrientation

jsx3.gui.LayoutGrid setOrientation(ORIENTATION : int)
Deprecated. Use setRows() and setCols() instead.
Sets whether the layout grid will render items top-over (--) or side-by-side (|); returns reference to self to facilitate method chaining

Parameters:

ORIENTATION – if null, jsx3.gui.LayoutGrid.DEFAULTORIENTATION will be used; otherwise, one of: jsx3.gui.LayoutGrid.ORIENTATIONROW or jsx3.gui.LayoutGrid.ORIENTATIONCOL

Returns:

this object 

setRepeat

jsx3.gui.LayoutGrid setRepeat(intCellCount : int)
Deprecated.
Sets the number of cells to draw before starting a new row/column of cells; returns reference to self to facilitate method chaining

Parameters:

intCellCount – number of cells to draw before starting a new row/column of cells; since null is not allowed, pass 0 if you don't want any child elements to render to the on-screen VIEW

Returns:

this object 

setRows

jsx3.gui.LayoutGrid setRows(strRows : String, bRepaint : ?)

Parameters:

strRows –
bRepaint –

Returns:

this object. 

Since:

3.4
Copyright © 2001-2008, TIBCO Software Inc.