jsx3.gui

class Block

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

Direct Known Subclasses:

class Block
extends jsx3.gui.Painted

This class provides a container-based, object-oriented approach to creating static html objects (basically this class creates "DIV" objects). This class is useful for creating objects as simple as 'labels' that can be placed anywhere on the screen. The advantage to using this class instead of trying to insert static html in the html window is that it allows the given HTML string to be managed by the 'container-management' strategy employed by the JSX Architecture

Field Summary
static int	ABSOLUTE 0
static String	ALIGNCENTER center
static String	ALIGNLEFT left (default)
static String	ALIGNRIGHT right
static String	DEFAULTCLASSNAME jsx30block
static String	DEFAULTCOLOR #000000
static String	DEFAULTFONTNAME Verdana
static int	DEFAULTFONTSIZE 10
static String	DEFAULTTAGNAME span
static String	DEFAULTTEXT
static String	DISPLAYBLOCK [empty string] (default)
static String	DISPLAYNONE none
static String	FONTBOLD bold
static String	FONTNORMAL normal (default)
static int	NULLSTYLE Deprecated.
static int	OVERFLOWEXPAND 3 (default)
static int	OVERFLOWHIDDEN 2
static int	OVERFLOWSCROLL 1
static int	RELATIVE 1 (default)
static int	SCROLLSIZE Deprecated.
static String	SPACE JSX/images/spc.gif
static String	VISIBILITYHIDDEN
static String	VISIBILITYVISIBLE

Constructor Summary
void	init(strName : String, vntLeft : int \| String, vntTop : int \| String, vntWidth : int \| String, vntHeight : int \| String, strHTML : String) instance initializer

Method Summary
String	getBackground() Returns valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
String	getBackgroundColor() Returns valid CSS property value, (e.g.
String	getBorder() Returns CSS property value(s) for a border (border: solid 1px #000000)
void	getCDFAttribute() Returns the named attribute on the CDF record to which this object is mapped.
void	getCDFId() Returns the CDF ID of the record to map to.
String	getCSSOverride() Returns CSS text to override the standard instance properties on the painted object.
String	getClassName() Returns the named CSS rule(s) to apply to the painted object.
String	getColor() Returns valid CSS property value, (e.g.
String	getCursor() Returns valid CSS property value, (e.g.
Array<int>	getDimensions() Returns the dimensions in an array of four int values
String	getDisplay() Returns the CSS display for the object; one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;)
String	getFontName() Returns the CSS font-family for the object
int	getFontSize() Returns the CSS font-size for the object
String	getFontWeight() Returns the CSS font-weight for the object ("bold" or "normal")
int \| String	getHeight() Returns the height property of this object.
int	getIndex() Returns IE tab index for setting the tabIndex property for the on-screen DHTML for the object
static jsx3.gui.Block	getJSXParent(objGUI : HTMLElement) Deprecated. Use `jsx3.html.getJSXParent()` instead.
int \| String	getLeft() Returns the left property of this object.
String	getMargin() Returns CSS property value(s) for a margin (margin:4px;)
int	getOverflow() Returns the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height
String	getPadding() Returns CSS property value(s) for a padding (padding:4px;)
int	getRelativePosition() Returns if the instance is relatively positioned on-screen; returns one of: jsx3.gui.Block.ABSOLUTE jsx3.gui.Block.RELATIVE
String	getTagName() Returns HTML tag name to use when rendering the object on-screen (span is the default); if the property is null, jsx3.gui.Block.DEFAULTTAGNAME is used;
String	getText() Returns the text/HTML for the control to be displayed on-screen; returns an empty string if null; since the text is rendered on-screen as browser-native HTML, the equivalent of an empty tag (e.g.
String	getTextAlign() Returns the CSS text-align property for the object; if no property value exists, jsx3.gui.Block.ALIGNLEFT is returned by default
String	getTip() Returns the tooltip text to display when the object is hovered over.
int \| String	getTop() Returns the top property of this object.
static String	getVersion() Deprecated.
String	getVisibility() Returns the visibility property for the object
int \| String	getWidth() Returns the width property of this object.
int	getZIndex() Returns the CSS z-index property
void	hideMask() Removes the "blocking" mask inside the block to stop user interactions with existing content
String	paint(strData : String) Returns the DHTML, used for this object's on-screen view
jsx3.gui.Block	setBackground(strBG : String) Sets valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setBackgroundColor(strColor : String, bUpdateView : boolean) Sets valid CSS property value, (e.g.
jsx3.gui.Block	setBorder(strCSS : String, bUpdateView : boolean) Sets CSS property value(s) for a border (border: solid 1px #000000).
void	setCDFAttribute(strAttName : String) Sets the named attribute on the CDF record to which this object is mapped.
void	setCDFId(strCDFId : String) Sets the CDF ID of the record to map to.
jsx3.gui.Block	setCSSOverride(strCSS : String) Sets CSS text to override the standard instance properties on the painted object.
jsx3.gui.Block	setClassName(strClassName : String) Sets the named CSS rule(s) to apply to the painted object.
jsx3.gui.Block	setColor(strColor : String, bUpdateView : boolean) Sets valid CSS property value, (e.g.
void	setCursor(strCursor : String, bUpdateView : boolean) Sets valid CSS property value, (e.g.
void	setDimensions(left : int \| String \| Array<int \| String>, top : int \| String, width : int \| String, height : int \| String, bUpdateView : boolean) Set one to four dimensions at once.
jsx3.gui.Block	setDisplay(DISPLAY : String, bUpdateView : boolean) Sets the display for the object.
jsx3.gui.Block	setFontName(strFontName : String) Sets the CSS font-family for the object; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setFontSize(intPixelSize : int) Sets the CSS font-size for the object; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setFontWeight(FONTWEIGHT : String) Sets the CSS font-weight for the object ("bold" or "normal"); returns reference to self to facilitate method chaining;
jsx3.gui.Block	setHeight(vntHeight : int \| String, bUpdateView : boolean) Sets the height property of this object.
jsx3.gui.Block	setIndex(intIndex : int, bUpdateView : boolean) Sets IE tab index for setting the tabIndex property for the on-screen DHTML for the object; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setLeft(vntLeft : int \| String, bUpdateView : boolean) Sets the left property of this object.
jsx3.gui.Block	setMargin(strCSS : String, bUpdateView : boolean) Sets CSS property value for margin.
jsx3.gui.Block	setOverflow(OVERFLOW : int) Sets the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setPadding(strCSS : String, bUpdateView : boolean) Sets the CSS property value for padding an object.
jsx3.gui.Block	setRelativePosition(intRelative : int, bUpdateView : boolean) Sets if the jsx3.gui.Block instance is relatively positioned on-screen; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setTagName(strTagName : String) Sets HTML tag name to use when rendering the object on-screen (jsx3.gui.Block.DEFAULTTAGNAME is the default); returns reference to self to facilitate method chaining;
jsx3.gui.Block	setText(strText : String, bRepaint : boolean) Sets the text/HTML for the control to be displayed on-screen; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setTextAlign(ALIGN : String) Sets the CSS text-align property for the object; returns reference to self to facilitate method chaining;
jsx3.gui.Block	setTip(strTip : String) Sets the tooltip text to display when the object is hovered over; updates the model and the view immediately.
jsx3.gui.Block	setTop(vntTop : int \| String, bUpdateView : boolean) Sets the top property of this object.
void	setVisibility(VISIBILITY : String, bUpdateView : boolean) Sets the CSS visibility property the object
jsx3.gui.Block	setWidth(vntWidth : int \| String, bUpdateView : boolean) Sets the width property of this object.
void	setZIndex(intZIndex : int, bUpdateView : boolean) Sets the CSS z-index for the object
void	showMask(strMessage : String) Displays a "blocking mask" inside the block to stop user interactions with content within the block.

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, paintChild, 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

ABSOLUTE

static final int ABSOLUTE

ALIGNCENTER

static final String ALIGNCENTER

center

ALIGNLEFT

static final String ALIGNLEFT

left (default)

ALIGNRIGHT

static final String ALIGNRIGHT

right

DEFAULTCLASSNAME

static String DEFAULTCLASSNAME

jsx30block

DEFAULTCOLOR

static String DEFAULTCOLOR

#000000

DEFAULTFONTNAME

static String DEFAULTFONTNAME

Verdana

DEFAULTFONTSIZE

static int DEFAULTFONTSIZE

DEFAULTTAGNAME

static String DEFAULTTAGNAME

span

DEFAULTTEXT

static String DEFAULTTEXT

DISPLAYBLOCK

static final String DISPLAYBLOCK

[empty string] (default)

DISPLAYNONE

static final String DISPLAYNONE

none

FONTBOLD

static final String FONTBOLD

bold

FONTNORMAL

static final String FONTNORMAL

normal (default)

NULLSTYLE

static int NULLSTYLE

Deprecated.

-1

OVERFLOWEXPAND

static final int OVERFLOWEXPAND

3 (default)

OVERFLOWHIDDEN

static final int OVERFLOWHIDDEN

OVERFLOWSCROLL

static final int OVERFLOWSCROLL

RELATIVE

static final int RELATIVE

1 (default)

SCROLLSIZE

static int SCROLLSIZE

Deprecated.

SPACE

static String SPACE

JSX/images/spc.gif

VISIBILITYHIDDEN

static final String VISIBILITYHIDDEN

VISIBILITYVISIBLE

static final String VISIBILITYVISIBLE

Constructor Detail

init

void init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String, strHTML : String)

instance initializer

Parameters:

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

vntLeft – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen

vntTop – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen

vntWidth – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen

vntHeight – either a number (i.e, 12, 30, etc) or a number and a unit value (i.e., "25%", "36pt", etc); if a number is passed, pixels will be the assumed unit when painted to screen

strHTML – Text/HTML markup to place in the jsx3.gui.Block instance

Method Detail

getBackground

String getBackground()

Returns valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;

Returns:

valid CSS property for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;

getBackgroundColor

String getBackgroundColor()

Returns valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))

Returns:

valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))

getBorder

String getBorder()

Returns CSS property value(s) for a border (border: solid 1px #000000)

Returns:

getCDFAttribute

void getCDFAttribute()

Returns the named attribute on the CDF record to which this object is mapped.

getCDFId

void getCDFId()

Returns the CDF ID of the record to map to.

getCSSOverride

String getCSSOverride()

Returns CSS text to override the standard instance properties on the painted object.

Returns:

CSS text

getClassName

String getClassName()

Returns the named CSS rule(s) to apply to the painted object.

Returns:

getColor

String getColor()

Returns valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))

Returns:

valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))

getCursor

String getCursor()

Returns valid CSS property value, (e.g., default,wait,col-resize); if no value or an empty string, null is returned

Returns:

valid CSS property value, (e.g., default,wait,col-resize)

getDimensions

Array<int> getDimensions()

Returns the dimensions in an array of four int values

Returns:

[left,top,width,height]

getDisplay

String getDisplay()

Returns the CSS display for the object; one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;)

Returns:

getFontName

String getFontName()

Returns the CSS font-family for the object

Returns:

valid CSS font-family property value

getFontSize

int getFontSize()

Returns the CSS font-size for the object

Returns:

font-size (in pixels)

getFontWeight

String getFontWeight()

Returns the CSS font-weight for the object ("bold" or "normal")

Returns:

[jsx3.gui.Block.FONTBOLD. jsx3.gui.Block.FONTNORMAL]

getHeight

int | String getHeight()

Returns the height property of this object.

Returns:

height.

getIndex

int getIndex()

Returns IE tab index for setting the tabIndex property for the on-screen DHTML for the object

Returns:

getJSXParent

static jsx3.gui.Block getJSXParent(objGUI : HTMLElement)

Deprecated. Use jsx3.html.getJSXParent() instead.

Returns the first JSX parent (as a JSX instance in the model) of @objGUI (an HTML element in the view); returns null if no jsx parent could be found

Parameters:

objGUI – HTML element in the view from which to begin looking for the first containing JSX parent in the model

Returns:

JSX object

getLeft

int | String getLeft()

Returns the left property of this object.

Returns:

left.

getMargin

String getMargin()

Returns CSS property value(s) for a margin (margin:4px;)

Returns:

getOverflow

int getOverflow()

Returns the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height

Returns:

[jsx3.gui.Block.OVERFLOWSCROLL, jsx3.gui.Block.OVERFLOWHIDDEN, jsx3.gui.Block.OVERFLOWEXPAND]

getPadding

String getPadding()

Returns CSS property value(s) for a padding (padding:4px;)

Returns:

getRelativePosition

int getRelativePosition()

Returns if the instance is relatively positioned on-screen; returns one of: jsx3.gui.Block.ABSOLUTE jsx3.gui.Block.RELATIVE

Returns:

getTagName

String getTagName()

Returns HTML tag name to use when rendering the object on-screen (span is the default); if the property is null, jsx3.gui.Block.DEFAULTTAGNAME is used;

Returns:

valid HTML tag name

getText

String getText()

Returns the text/HTML for the control to be displayed on-screen; returns an empty string if null; since the text is rendered on-screen as browser-native HTML, the equivalent of an empty tag (e.g., <span\>) would be an enclosing tag with an empty string (no content): . To return null would be equivalent to null, which is not the same as

Returns:

getTextAlign

String getTextAlign()

Returns the CSS text-align property for the object; if no property value exists, jsx3.gui.Block.ALIGNLEFT is returned by default

Returns:

one of: jsx3.gui.Block.ALIGNLEFT, jsx3.gui.Block.ALIGNRIGHT, jsx3.gui.Block.ALIGNCENTER

getTip

String getTip()

Returns the tooltip text to display when the object is hovered over.

Returns:

getTop

int | String getTop()

Returns the top property of this object.

Returns:

top.

getVersion

static String getVersion()

Deprecated.

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

Returns:

getVisibility

String getVisibility()

Returns the visibility property for the object

Returns:

[jsx3.gui.Block.VISIBILITYVISIBLE, jsx3.gui.Block.VISIBILITYHIDDEN]

getWidth

int | String getWidth()

Returns the width property of this object.

Returns:

width.

getZIndex

int getZIndex()

Returns the CSS z-index property

Returns:

hideMask

void hideMask()

Removes the "blocking" mask inside the block to stop user interactions with existing content

paint

String paint(strData : String)

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

Parameters:

strData – Text/HTML markup that will replace value of getText() during paint—typically passed by subclass, JSXBlockX after it performs an XML/XSL merge to acquire its data; for memory management purposes, the data is not set via setText() and, instead, is passed as a temporary input parameter, as the object's model would contain the text for no reason

Returns:

DHTML

Overrides:

paint in jsx3.gui.Painted

setBackground

jsx3.gui.Block setBackground(strBG : String)

Sets valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat; returns reference to self to facilitate method chaining;

Parameters:

strBG – valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;

Returns:

this object

setBackgroundColor

jsx3.gui.Block setBackgroundColor(strColor : String, bUpdateView : boolean)

Sets valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0)); returns reference to self to facilitate method chaining;

Parameters:

strColor – valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object

setBorder

jsx3.gui.Block setBorder(strCSS : String, bUpdateView : boolean)

Sets CSS property value(s) for a border (border: solid 1px #000000). Properties can be strung together as in: border:solid 1px #989885;border-left-width:0px;

Parameters:

strCSS – valid CSS property value for a border (border: solid 1px #000000)

bUpdateView – if true, the view will be updated with requiring a repaint

Returns:

this object

setCDFAttribute

void setCDFAttribute(strAttName : String)

Sets the named attribute on the CDF record to which this object is mapped. Updates to show the new mapped value

Parameters:

strAttName –

setCDFId

void setCDFId(strCDFId : String)

Sets the CDF ID of the record to map to. Updates to show the new mapped value

Parameters:

strCDFId – If not set, the CDF Id used by the nearest ancestor of type jsx3.gui.CDF will be used.

setCSSOverride

jsx3.gui.Block setCSSOverride(strCSS : String)

Sets CSS text to override the standard instance properties on the painted object. 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.

Parameters:

strCSS – CSS text. For example, color:red;background-color:orange;

Returns:

this object

setClassName

jsx3.gui.Block setClassName(strClassName : String)

Sets the named CSS rule(s) to apply to the painted object. Rules that specify border-width, padding, margin, width, and height are strongly discouraged. Multiple rules may be specified, delimited with a space. For example, label emphasis. Since some controls are composited from multiple HTML elements, some rule styles may not cascade to nested elements. Dynamic Properties are the preferred method for applying global styles.

Parameters:

strClassName – CSS property name without the leading "."

Returns:

this object

setColor

jsx3.gui.Block setColor(strColor : String, bUpdateView : boolean)

Sets valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0)); returns reference to self to facilitate method chaining;

Parameters:

strColor – valid CSS property value, (e.g., red, #ffffff, rgb(255,0,0))

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object

setCursor

void setCursor(strCursor : String, bUpdateView : boolean)

Sets valid CSS property value, (e.g., default,wait,col-resize)

Parameters:

strCursor – valid CSS property value, (e.g., default,wait,col-resize)

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

setDimensions

Set one to four dimensions at once. This operation is more efficient than calling more than one of setLeft, setTop, etc. Any argument can be null to indicate not to update it.

Parameters:

left – the new left value or an array containing all four new values

top – the new top value

width – the new width value

height – the new height value

bUpdateView – whether to update the display of this object immediately. If left is an Array then this parameter is the second parameter passed to this method.

setDisplay

jsx3.gui.Block setDisplay(DISPLAY : String, bUpdateView : boolean)

Sets the display for the object. Note that although the framework uses CSS to apply this setting, the actual values that get set are determined by the system. Only those parameters listed for @DISPLAY are supported as inputs to this function.

Parameters:

DISPLAY – one of jsx3.gui.Block.DISPLAYNONE or jsx3.gui.Block.DISPLAYBLOCK

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object

setFontName

jsx3.gui.Block setFontName(strFontName : String)

Sets the CSS font-family for the object; returns reference to self to facilitate method chaining;

Parameters:

strFontName – valid CSS font-family property value

Returns:

this object

setFontSize

jsx3.gui.Block setFontSize(intPixelSize : int)

Sets the CSS font-size for the object; returns reference to self to facilitate method chaining;

Parameters:

intPixelSize – font-size (in pixels)

Returns:

this object

setFontWeight

jsx3.gui.Block setFontWeight(FONTWEIGHT : String)

Sets the CSS font-weight for the object ("bold" or "normal"); returns reference to self to facilitate method chaining;

Parameters:

FONTWEIGHT – [jsx3.gui.Block.FONTBOLD. jsx3.gui.Block.FONTNORMAL]

Returns:

this object

setHeight

jsx3.gui.Block setHeight(vntHeight : int | String, bUpdateView : boolean)

Sets the height property of this object.

Parameters:

vntHeight – the height as a non-negative integer or non-negative percentage. For example: 45%, 12.

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object.

setIndex

jsx3.gui.Block setIndex(intIndex : int, bUpdateView : boolean)

Sets IE tab index for setting the tabIndex property for the on-screen DHTML for the object; returns reference to self to facilitate method chaining;

Parameters:

intIndex – any value in the valid range of -32767 to 32767

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object

setLeft

jsx3.gui.Block setLeft(vntLeft : int | String, bUpdateView : boolean)

Sets the left property of this object. The left property specifies the horizontal offset of this object from its parent and only applies if this object is absolutely positioned.

Parameters:

vntLeft – the left value. Only numeric values and percentages are supported. For example: 25, -10, 20%.

bUpdateView – if @vntLeft is in integer (a number with no modifier) and @bUpdateView is true, the object's on-screen view is immediately updated to match its model, obviating the need to call '[object].repaint()'

Returns:

this object.

setMargin

jsx3.gui.Block setMargin(strCSS : String, bUpdateView : boolean)

Sets CSS property value for margin.

Parameters:

strCSS – The preferred method to set margin is by moving clockwise, beginning with the north compass position, without the pixel designation. For example, to specify a top margin of 8 pixels, use 8 0 0 0. CSS syntax is supported, but requires that pixels be designated. For example, using margin:5px;margin-left:10px;, is equivalent to 5 5 5 10.

bUpdateView – if true, the view will be updated with requiring a repaint

Returns:

this object

setOverflow

jsx3.gui.Block setOverflow(OVERFLOW : int)

Sets the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height; returns reference to self to facilitate method chaining;

Parameters:

OVERFLOW – [jsx3.gui.Block.OVERFLOWSCROLL, jsx3.gui.Block.OVERFLOWHIDDEN, jsx3.gui.Block.OVERFLOWEXPAND]

Returns:

this object

setPadding

jsx3.gui.Block setPadding(strCSS : String, bUpdateView : boolean)

Sets the CSS property value for padding an object.

Parameters:

strCSS – The preferred method to set padding is by moving clockwise, beginning with the north compass position, without the pixel designation. For example, to specify a top padding of 8 pixels, use 8 0 0 0. CSS syntax is supported, but requires that pixels be designated. For example, using padding:5px;padding-left:10px;, is equivalent to 5 5 5 10.

bUpdateView – if true, the view will be updated without requiring a repaint.

Returns:

this object.

setRelativePosition

jsx3.gui.Block setRelativePosition(intRelative : int, bUpdateView : boolean)

Sets if the jsx3.gui.Block instance is relatively positioned on-screen; returns reference to self to facilitate method chaining;

Parameters:

intRelative – jsx3.gui.Block.RELATIVE will be applied to the view if null. One of: jsx3.gui.Block.RELATIVE jsx3.gui.Block.ABSOLUTE

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object

setTagName

jsx3.gui.Block setTagName(strTagName : String)

Sets HTML tag name to use when rendering the object on-screen (jsx3.gui.Block.DEFAULTTAGNAME is the default); returns reference to self to facilitate method chaining;

Parameters:

strTagName – valid HTML tag name (span, div, form, ol, ul, li, etc); if null is passed, the getter will use jsx3.gui.Block.DEFAULTTAGNAME

Returns:

this object

setText

jsx3.gui.Block setText(strText : String, bRepaint : boolean)

Sets the text/HTML for the control to be displayed on-screen; returns reference to self to facilitate method chaining;

Parameters:

strText – text/HTML

bRepaint – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

setTextAlign

jsx3.gui.Block setTextAlign(ALIGN : String)

Sets the CSS text-align property for the object; returns reference to self to facilitate method chaining;

Parameters:

ALIGN – one of: jsx3.gui.Block.ALIGNLEFT, jsx3.gui.Block.ALIGNRIGHT, jsx3.gui.Block.ALIGNCENTER

Returns:

setTip

jsx3.gui.Block setTip(strTip : String)

Sets the tooltip text to display when the object is hovered over; updates the model and the view immediately. Note that the tip text is rendered natively by the browser and that the behavior may vary between browsers. Some browsers may honor line breaks in the text and some may have a maximum length that then show before truncating the tip. For more consistent rendering across browsers use the SPYGLASS event instead.

Parameters:

strTip – the tip text.

Returns:

this object.

setTop

jsx3.gui.Block setTop(vntTop : int | String, bUpdateView : boolean)

Sets the top property of this object. The top property specifies the vertical offset of this object from its parent and only applies if this object is absolutely positioned.

Parameters:

vntTop – the top value. Only numeric values and percentages are supported. For example: 25, -10, 20%.

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object.

setVisibility

void setVisibility(VISIBILITY : String, bUpdateView : boolean)

Sets the CSS visibility property the object

Parameters:

VISIBILITY – [jsx3.gui.Block.VISIBILITYVISIBLE, jsx3.gui.Block.VISIBILITYHIDDEN]

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

setWidth

jsx3.gui.Block setWidth(vntWidth : int | String, bUpdateView : boolean)

Sets the width property of this object.

Parameters:

vntWidth – the width as non-negative integer or non-negative percentage. For example: 45%, 12.

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

Returns:

this object.

setZIndex

void setZIndex(intZIndex : int, bUpdateView : boolean)

Sets the CSS z-index for the object

Parameters:

intZIndex – z-index value

bUpdateView – if true, the view of this object is immediately updated, obviating the need to call repaint().

showMask

void showMask(strMessage : String)

Displays a "blocking mask" inside the block to stop user interactions with content within the block. Applies only to Blocks. Use only on blocks with no padding and with overflow set to hidden.

Parameters:

strMessage – text/message to display in the blocking mask to tell the user it is disabled