OverviewSingleDeprecated

jsx3.html

class BlockTag

Object
->jsx3.lang.Object
  ->jsx3.html.Tag
    ->jsx3.html.BlockTag

Direct Known Subclasses:

jsx3.vector.Canvas, jsx3.vector.Tag

class BlockTag
extends jsx3.html.Tag
Represents an HTML element that occupies a rectangle of the screen.

This class is available only when the Charting add-in is enabled.

Constructor Summary
void
init(strTagNS : String, strTagName : String, left : int, top : int, width : int, height : int)
The instance initializer.
Method Summary
String
Returns the bgcolor field.
Array<int>
Returns the dimensions in an array of four int values
int
Returns the height field.
int
Returns the left field.
String
Returns the margin field, as set by setMargin().
Array
parses the margin field into an array of four int values
String
Returns the padding field, as set by setPadding().
Array
parses the padding field into an array of four int values
String
Returns the position field.
int
Returns the top field.
int
Returns the width field.
int
Returns the zIndex field.
void
Sets the bgcolor field.
void
setDimensions(left : int | Array<int>, top : int, width : int, height : int)
Sets all four dimensions at once.
void
setHeight(height : int)
Sets the height field.
void
setLeft(left : int)
Sets the left field.
void
setMargin(margin : String)
Sets the margin field, can be a single value or four values separated by space that correspond to top, right, bottom, and left.
void
setPadding(padding : String)
Sets the padding field, can be a single value or four values separated by space that correspond to top, right, bottom, and left.
void
setPosition(position : String)
Sets the position field, can be 'absolute' or 'relative'.
void
setTop(top : int)
Sets the top field.
void
setWidth(width : int)
Sets the width field.
void
setZIndex(zIndex : int)
Sets the zIndex field.
Methods Inherited From jsx3.html.Tag
appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString
Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf
Constructor Detail

init

void init(strTagNS : String, strTagName : String, left : int, top : int, width : int, height : int)
The instance initializer.

Parameters:

strTagNS
strTagName
leftleft position (in pixels) of the object relative to its parent container
toptop position (in pixels) of the object relative to its parent container
widthwidth (in pixels) of the object
heightheight (in pixels) of the object
Method Detail

getBackgroundColor

String getBackgroundColor()
Returns the bgcolor field.

Returns:

bgcolor  

getDimensions

Array<int> getDimensions()
Returns the dimensions in an array of four int values

Returns:

[left,top,width,height]  

getHeight

int getHeight()
Returns the height field.

Returns:

height  

getLeft

int getLeft()
Returns the left field.

Returns:

left  

getMargin

String getMargin()
Returns the margin field, as set by setMargin().

Returns:

margin  

getMarginDimensions

Array getMarginDimensions()
parses the margin field into an array of four int values

Returns:

[top,right,bottom,left]  

getPadding

String getPadding()
Returns the padding field, as set by setPadding().

Returns:

padding  

getPaddingDimensions

Array getPaddingDimensions()
parses the padding field into an array of four int values

Returns:

[top,right,bottom,left]  

getPosition

String getPosition()
Returns the position field.

Returns:

position  

getTop

int getTop()
Returns the top field.

Returns:

top  

getWidth

int getWidth()
Returns the width field.

Returns:

width  

getZIndex

int getZIndex()
Returns the zIndex field.

Returns:

zIndex  

setBackgroundColor

void setBackgroundColor(bgcolor : String)
Sets the bgcolor field.

Parameters:

bgcolorthe new value for bgcolor

setDimensions

void setDimensions(left : int | Array<int>, top : int, width : int, height : int)
Sets all four dimensions at once.

Parameters:

leftthe new left value or an array containing all four new values
topthe new top value
widththe new width value
heightthe new height value

setHeight

void setHeight(height : int)
Sets the height field.

Parameters:

heightthe new value for height

setLeft

void setLeft(left : int)
Sets the left field.

Parameters:

leftthe new value for left

setMargin

void setMargin(margin : String)
Sets the margin field, can be a single value or four values separated by space that correspond to top, right, bottom, and left.

Parameters:

marginthe new value for margin

setPadding

void setPadding(padding : String)
Sets the padding field, can be a single value or four values separated by space that correspond to top, right, bottom, and left.

Parameters:

paddingthe new value for padding

setPosition

void setPosition(position : String)
Sets the position field, can be 'absolute' or 'relative'.

Parameters:

positionthe new value for position

setTop

void setTop(top : int)
Sets the top field.

Parameters:

topthe new value for top

setWidth

void setWidth(width : int)
Sets the width field.

Parameters:

widththe new value for width

setZIndex

void setZIndex(zIndex : int)
Sets the zIndex field.

Parameters:

zIndexthe new value for zIndex