Class wtWidget

Object
   |
   +--wtObject
         |
         +--wtWidget

Direct Known Subclasses:

wtView, wtDisplayRow, wtRowLayout, wtImage, wtNotebook, wtRadioButton, wtCheckBox, wtButton, wtToolbar, wtColumnLayout, wtShadowWidget, wtDisplay, wtFormWidget, wtSpacer, wtAnchor, wtDisplayCell, wtToolbarItem

class wtWidget

extends wtObject

The base class of all visible widgets.

Available signals:

• Click
• MouseDown
• MouseOver
• MouseOut
• MouseUp
• Focus
• Blur
• DoubleClick
• KeyDown
• KeyUp
• KeyPress
• Resize
• Move
• DragStart
• DragEnd

Constructor Detail

wtWidget

wtWidget(<wtWidget> _parent, <String> _tagName)

Constructs a widget based on a DOM node

Parameters:
_parent - The container widget to add this widget to. Can also be a DOM node like document.body. Fill in null if you don't want to immediately add this widget to a container.
_tagName - The new DOM node's HTML tag

addWidget

wtWidget addWidget(<wtWidget|String> obj)

Adds a wtWidget inside this widget

Parameters:
obj - The wtWidget to be added. Alternatively, you may add a string to be displayed inside the widget.

Returns:
The widget added

clearAll

void clearAll()

Clears the contents of the widget.

getAbsolutePosition

Object getAbsolutePosition()

Gets the widget's current position relative to the upper left hand corner of its parent container

Returns:
"x": current x-axis position, "y": current y-axis position

getScreenPosition

Object getScreenPosition()

Gets the widget's current position relative to the upper left hand corner of the screen

Returns:
"x": current x-axis position, "y": current y-axis position

getStyle

Object getStyle(<String> name)

Gets a CSS style attribute value

Parameters:
name - CSS style name

isAncestorOf

Boolean isAncestorOf(<wtWidget> widget)

Tells if this widget is an ancenstor of another widget in the DOM tree

Parameters:
widget - The other widget

Returns:
Whether this widget is an ancenstor of the other widget or not

isEnabled

Boolean isEnabled()

Tells whether the widget is currently enabled or not

You may want to override this operation as well if you have overriden setEnabled() in your custom widget

Returns:
Whether the widget is currently enabled or not

isInside

Boolean isInside(<Number> x, <Number> y)

Tells whether a coordiate is inside the rectangular bounding box of the widget

Parameters:
x - The position on x-axis
y - The position on y-axis

Returns:
Whether the coordinate is inside this widget or not

linkSignal

void linkSignal(<String> signalName, <String> eventName)

Links a DOM object's event hook (e.g. "onclick") to a wtObject signal name

Parameters:
signalName - wtObject signal name
eventName - DOM object event hook name

removeSelf

void removeSelf()

Destroys the widget

setAbsolutePosition

void setAbsolutePosition(<Number> x, <Number> y)

Sets the widget's position to (+x, +y) relative to the upper left hand corner of its parent container

Parameters:
x - The widget's offset on x-axis
y - The widget's offset on y-axis

setAlpha

void setAlpha(<Number> opacity)

Sets the alpha transparency of the widget

Parameters:
opacity - The opacity of the widget in the range [0.0, 1.0], with 0.0 meaning completely transparent and 1.0 meaning completely opaque

setDisplay

void setDisplay(<Boolean> yes)

Sets whether to display the widget or not

This function differs from wtWidget.setVisible() in which an non-displayed widget would not occupy space

Parameters:
yes - Whether the widget should be displayed or not

See:
- setVisible()

setDragArea

void setDragArea(<Number> leftLimit, <Number> topLimit, <Number> rightLimit, <Number> bottomLimit)

Sets the bounding area at which the widget can be dragged by the mouse cursor

Parameters:
leftLimit - The left side of the bounding box
topLimit - The top side of the bounding box
rightLimit - The right side of the bounding box
bottomLimit - The bottom side of the bounding box

setDraggable

void setDraggable(<Boolean> yes)

Sets whether the widget should be draggable

Parameters:
yes - The widget should be draggable or not

setEnabled

void setEnabled(<Boolean> yes)

Sets the widget to be enabled or not.

This general setEnabled() function only works reliably in Internet Explorer due to a layout bug in the GEcko engine If you need to use setEnabled() in your own widget classes, it is advisable to override this function unless you're sure the default implementation works

Parameters:
yes - Whether the widget is enabled or not

setLevel

void setLevel(<Number> level)

Sets the z-axis position of the widget. The z-axis position is used for determining the overlapping order of widgets. The large the z-axis position, the nearer the widget is to the user.

Parameters:
level - The widget's z-axis position

setPosition

void setPosition(<Number> x, <Number> y)

Sets the widget's position to (+x, +y) relative to it's current position

Parameters:
x - The widget's offset on x-axis
y - The widget's offset on y-axis

setRelativePosition

void setRelativePosition(<Number> x, <Number> y)

Sets the widget's position to (+x, +y) relative to its natural position

Parameters:
x - The widget's offset on x-axis
y - The widget's offset on y-axis

setSelectable

void setSelectable(<Boolean> yes)

Sets the widget to selectable or not

Note that this function is bugged in Internet Explorer, in which an "unselectable" widget can still be selected by dragging over a larger area or by draggable over irrelevant widgets This issue is not likely to be solved since it is a bug in Internet Explorer

Parameters:
yes - Whether the widget is selectable or not

setSize

void setSize(<String> _width, <String> _height)

Set the widget's size

Parameters:
_width - The widget's width as a CSS length quantity
_height - The widget's height as a CSS height quantity

setStaticPosition

void setStaticPosition()

Sets the widget's position to static. i.e. follow the natural document flow

setStyle

void setStyle(<String> name, <String> value)

Sets a CSS style attribute value

Parameters:
name - CSS style name
value - CSS style value

setVisible

void setVisible(<Boolean> yes)

Sets the widget's visibility

This function differs from wtWidget.setDisplay() in which an invisible widget would still occupy space

Parameters:
yes - Whether the widget should be visible or not

See:
- setDisplay()

unsetDragArea

void unsetDragArea()

Unsets the bounding area for dragging to the default behavior at which the widget can be dragged as long as the mouse cursor is positioned over the widget