jsx3.gui

class Column

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.gui.Column

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class Column
extends jsx3.gui.Block

Deprecated. Use jsx3.gui.Matrix.Column instead.

Provides a way to generate a column of data for a jsx3.gui.List instance (or compatible subclass). It allows the developer to specify custom XSLT for more-complex output, custom edit masks for editable grids, sort types and sort paths and other series-related activities.

Field Summary
static String	DEFAULTCELLCLASSGRID jsx30column_c3
static String	DEFAULTCELLCLASSLIST jsx30column_c1
static int	DEFAULTWIDTH 100
static int	FIXED 0
static int	RESIZABLE 1 (default)
static void	RESIZEABLE Deprecated. Renamed to RESIZABLE.
static String	TYPENUMBER number
static String	TYPETEXT text (default)
static String	VALIGNMIDDLE middle
static String	VALIGNTOP top (default)

Constructor Summary
void	init(strName : String, strText : String, intWidth : int, strPath : String) instance initializer

Method Summary
int	getCanSort() Returns whether the parent list/grid can be sorted on this column
String	getDataType() Returns the data type for this column of data (affects sorting if this column is used for sorting the data); valid types include: jsx3.gui.Column.TYPETEXT and jsx3.gui.Column.TYPENUMBER
String	getEditMask() Returns name of JSX GUI object to use as the edit mask
String	getPath() Returns the selection path for this column of data.
int	getResizable() Returns flag (jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED) denoting whether or not the given column can be resized.
void	getResizeable() Deprecated. Renamed to getResizable.
String	getSortPath() Returns the selection path to use to sort this column.
String	getVAlign() Gets the vertical alignment for the header cell text.
static String	getVersion() Deprecated.
int	getWrap() Gets whether or not the header cell for this column should wrap its text when the column is too narrow to display truncate with an ellipsis.
String	getXSLString(strXSL : ?) Returns XSLT fragment for any custom template to render the cells for this column.
String	paint(bBufferColumn : boolean, SORT_DIRECTION : String) Returns the DHTML, used for this object's on-screen VIEW
String	repaint() updates the on-screen VIEW for the object.
jsx3.gui.Column	setCanSort(SORT : int) Sets whether the parnet list/grid can be sorted on this column.
jsx3.gui.Column	setDataType(DATATYPE : String) Sets the data type for this column of data (affects sorting if this column is used for sorting the data); returns ref to self
jsx3.gui.Column	setEditMask(strJSXName : String) Sets name of JSX GUI object to use as the edit mask; can also can be the system-generated id assigned at object initialization; returns ref to self
jsx3.gui.Column	setPath(strPath : String) Sets the selection path for this column of data.
jsx3.gui.Column	setResizable(RESIZE : int) Sets flag (jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED) denoting whether or not the given column can be resized.
void	setResizeable() Deprecated. Renamed to setResizable.
jsx3.gui.Column	setSortPath(strPath : String) Sets the selection path to use to sort this column.
jsx3.gui.Column	setVAlign(VALIGN : String) Sets the vertical alignment for the header cell text.
jsx3.gui.Column	setWrap(WRAP : int) Sets whether or not the header cell for this column should wrap its text when the column is too narrow to display truncate with an ellipsis.
jsx3.gui.Column	setXSLString(strXSL : String) binds an XSL document fragment (as string) as a property on the object, so that when the object is serialized the XSL is contained within.

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, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, 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.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

DEFAULTCELLCLASSGRID

static String DEFAULTCELLCLASSGRID

jsx30column_c3

DEFAULTCELLCLASSLIST

static String DEFAULTCELLCLASSLIST

jsx30column_c1

DEFAULTWIDTH

static int DEFAULTWIDTH

100

FIXED

static final int FIXED

RESIZABLE

static final int RESIZABLE

1 (default)

RESIZEABLE

static ? RESIZEABLE

Deprecated. Renamed to RESIZABLE.

TYPENUMBER

static final String TYPENUMBER

number

TYPETEXT

static final String TYPETEXT

text (default)

VALIGNMIDDLE

static String VALIGNMIDDLE

middle

VALIGNTOP

static String VALIGNTOP

top (default)

Constructor Detail

init

void init(strName : String, strText : String, intWidth : int, strPath : String)

instance initializer

Parameters:

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

strText – label to appear in column header; can be valid DHTML

intWidth – width (in pixels) of the object;

strPath – the selection path for this column of data. Typically this is simply the name of the attribute preceded by '@' (i.e., @jsxtext, @social, @phone, etc);

Method Detail

getCanSort

int getCanSort()

Returns whether the parent list/grid can be sorted on this column

Returns:

one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getDataType

String getDataType()

Returns the data type for this column of data (affects sorting if this column is used for sorting the data); valid types include: jsx3.gui.Column.TYPETEXT and jsx3.gui.Column.TYPENUMBER

Returns:

data type for this column's data

getEditMask

String getEditMask()

Returns name of JSX GUI object to use as the edit mask

Returns:

name of the control

getPath

String getPath()

Returns the selection path for this column of data. Typically this is simply the name of the attribute preceded by '@' (i.e., @jsxtext, @social, @phone, etc); returns '@jsxid' if no path specified

Returns:

selection path (xpath / xsl query)

getResizable

int getResizable()

Returns flag (jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED) denoting whether or not the given column can be resized. Default: jsx3.gui.Column.RESIZABLE

Returns:

getResizeable

void getResizeable()

Deprecated. Renamed to getResizable.

getSortPath

String getSortPath()

Returns the selection path to use to sort this column. If the sort path has not been set explicitly, this method returns the value of this.getPath().

Returns:

getVAlign

String getVAlign()

Gets the vertical alignment for the header cell text. Default: jsx3.gui.Column.VALIGNTOP;

Returns:

one of: jsx3.gui.Column.VALIGNTOP or jsx3.gui.Column.VALIGNMIDDLE

getVersion

static String getVersion()

Deprecated.

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

Returns:

getWrap

int getWrap()

Gets whether or not the header cell for this column should wrap its text when the column is too narrow to display truncate with an ellipsis. Default: jsx3.Boolean.FALSE

Returns:

one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getXSLString

String getXSLString(strXSL : ?)

Returns XSLT fragment for any custom template to render the cells for this column.

Parameters:

strXSL –

Returns:

valid XSLT document fragment to be inserted into the overall XSLT document for the list/grid parent

paint

String paint(bBufferColumn : boolean, SORT_DIRECTION : String)

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

Parameters:

bBufferColumn – false if null; if true, the default xsl template for a buffer column cell is returned

SORT_DIRECTION – one of: jsx3.gui.List.SORTASCENDING or jsx3.gui.List.SORTDESCENDING

Returns:

DHTML

Overrides:

paint in jsx3.gui.Block

repaint

String repaint()

updates the on-screen VIEW for the object. repaints both the head and body for the list/grid containing the column (colunns are composed of HTML TD elements that cannot be repainted individually)

Returns:

DHTML

Overrides:

repaint in jsx3.gui.Painted

setCanSort

jsx3.gui.Column setCanSort(SORT : int)

Sets whether the parnet list/grid can be sorted on this column. Default: jsx3.Boolean.TRUE

Parameters:

SORT – one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

Returns:

this object

setDataType

jsx3.gui.Column setDataType(DATATYPE : String)

Sets the data type for this column of data (affects sorting if this column is used for sorting the data); returns ref to self

Parameters:

DATATYPE – data type for this column's data; ; valid types include: jsx3.gui.Column.TYPETEXT and jsx3.gui.Column.TYPENUMBER

Returns:

this object

setEditMask

jsx3.gui.Column setEditMask(strJSXName : String)

Sets name of JSX GUI object to use as the edit mask; can also can be the system-generated id assigned at object initialization; returns ref to self

Parameters:

strJSXName – JSX name property for the control to use as the edit/input mask; also can be the system-generated id assigned at object initialization

Returns:

this object

setPath

jsx3.gui.Column setPath(strPath : String)

Sets the selection path for this column of data. Typically this is simply the name of the attribute preceded by '@' (i.e., @jsxtext, @social, @phone, etc); returns a ref to self;

Parameters:

strPath – selection path (xpath / xsl query)

Returns:

this object

setResizable

jsx3.gui.Column setResizable(RESIZE : int)

Sets flag (jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED) denoting whether or not the given column can be resized. Default: jsx3.gui.Column.RESIZABLE

Parameters:

RESIZE – one of: jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED

Returns:

this object

setResizeable

void setResizeable()

Deprecated. Renamed to setResizable.

setSortPath

jsx3.gui.Column setSortPath(strPath : String)

Sets the selection path to use to sort this column. By setting the sort path property, a column may cause its list to be sorted according to data that is not necessarily the string displayed in the column.

Parameters:

strPath –

Returns:

setVAlign

jsx3.gui.Column setVAlign(VALIGN : String)

Sets the vertical alignment for the header cell text. This does not affect the vertical alignment for the data rows.

Parameters:

VALIGN – one of: jsx3.gui.Column.VALIGNTOP or jsx3.gui.Column.VALIGNMIDDLE

Returns:

this object

setWrap

jsx3.gui.Column setWrap(WRAP : int)

Sets whether or not the header cell for this column should wrap its text when the column is too narrow to display truncate with an ellipsis.

Parameters:

WRAP – one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

Returns:

this object

setXSLString

jsx3.gui.Column setXSLString(strXSL : String)

binds an XSL document fragment (as string) as a property on the object, so that when the object is serialized the XSL is contained within. When this object is live, the XSL will be parsed and used to generate the on-screen VIEW for the object

Parameters:

strXSL – if null or empty string is passed, any existing value is removed. Otherwise, must be XSLT fragment that will generate the content for a given TD (cell)

Returns:

this object

class Column

All Implemented Interfaces:

See Also:

Parameters:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

See Also:

Returns:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Overrides:

Returns:

Overrides:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns: