org.xul.script.xul.model

Class AbstractXULWidget

java.lang.Object

org.xul.script.xul.model.AbstractXULElement

org.xul.script.xul.model.AbstractXULWidget

All Implemented Interfaces:

XULConstants, XULElement, XULWidget

Direct Known Subclasses:

AbstractXULMenuParent, XULButton, XULCheckBox, XULContainer, XULFileField, XULImage, XULLabel, XULListBox, XULListCell, XULListItem, XULMenuBar, XULMenuButton, XULMenuPopup, XULProgressMeter, XULScale, XULScrollBar, XULSpacer, XULTab, XULTabBox, XULTabPanel, XULTextBox, XULToolbar, XULToolbarItem, XULToolbarSpacer, XULToolbox, XULTree, XULTreeCell, XULTreeCol, XULTreeItem, XULWindow

public abstract class AbstractXULWidget
extends AbstractXULElement
implements XULWidget

A generic abstract XUL Widget. All XUL Widgets following characteristics are handled:

• width, height, minWidth, minHeight, maxWidth, maxHeight
• left, top
• hidden
• tooltiptext

Field Summary

Fields

Modifier and Type	Field and Description
protected short	align The alignment.
protected java.util.Map<java.lang.String,FunctionBinding>	bindings

Fields inherited from class org.xul.script.xul.model.AbstractXULElement

comp, document, elt

Fields inherited from interface org.xul.script.xul.model.XULConstants

ALIGN, CHECKED, CLASS, COLS, CURPOS, CURRENTINDEX, CURRENTITEM, DECIMALPLACES, DIALOGTYPE, DIRECTORY, DISABLED, DOCUMENT, EDITABLE, EDITING_COLUMN, EDITING_ROW, EXTENSIONS, HEIGHT, HIDDEN, HORIZONTAL, ID, IMAGE, INCREMENT, ITEMCOUNT, LABEL, LEFT, MAX, MAX_HEIGHT, MAX_WIDTH, MAXPOS, MIN, MIN_HEIGHT, MIN_WIDTH, MODE, MULTILINE, ORIENT, PAGEINCREMENT, RESIZABLE, ROWS, SCREENX, SCREENY, SELECTED, SELECTEDINDEX, SRC, STYLE, TITLE, TOOLTIPTEXT, TOP, TYPE, VALUE, VERTICAL, VIEW, WIDTH, WINDOW, WRAP

Constructor Summary

Constructors

Constructor and Description
AbstractXULWidget()
AbstractXULWidget(XULDocument document, org.w3c.dom.Element elt)

Method Summary

Modifier and Type	Method and Description
protected void	bindAnyAction(java.lang.String actionType, java.lang.String command) Bind any kind of action.
void	bindChangeAction(java.lang.String command) Bind an "onchange" action.
protected void	bindChangeActionImpl(java.lang.String command) Bind an "onchange" action without delegating to bindCommandAction(java.lang.String).
void	bindCommandAction(java.lang.String command) Bind an "oncommand" action.
void	bindMouseOutAction(java.lang.String command) Bind an "onmouseover" action.
void	bindMouseOverAction(java.lang.String command) Bind an "onmouseover" action.
void	bindSelectAction(java.lang.String command) Bind an "onmouseover" action.
java.lang.Object	get(java.lang.String property) Return the value of a property.
short	getAlignment() Return the alignment.
XULDocument	getDocument() Return the document.
FunctionBinding	getFunctionBinding(java.lang.String actionType) Return the function bound to the widget action.
java.lang.String	getOnChange() Return the onchange function name.
java.lang.String	getOnCommand() Return the oncommand function name.
java.lang.String	getOnMouseOut() Return the onmouseout function name.
java.lang.String	getOnMouseOver() Return the onmouseover function name.
java.lang.String	getOnSelect() Return the onselect function name.
java.lang.String	getStyle() Return the style attribute for the widget.
java.util.Set<CSSSelector>	getStyleClasses() Return the style classes for the widget.
java.lang.String	getWidgetType() Return the widget type.
void	jsSet_class(java.lang.String value)
void	jsSet_height(java.lang.String value)
void	jsSet_hidden(java.lang.String value)
void	jsSet_left(java.lang.String value)
void	jsSet_style(java.lang.String value)
void	jsSet_tooltiptext(java.lang.String value)
void	jsSet_top(java.lang.String value)
void	jsSet_width(java.lang.String value)
protected void	reapplyStyle()
protected void	reapplyStyle(short pseudoClass)
protected void	resetMaximumSize(java.awt.Dimension d) Reset the maximum size of the widget component.
protected void	resetMinimumSize(java.awt.Dimension d) Reset the minimum size of the widget component.
protected void	resetPosition(int left, int top) Reset the position of the widget component.
protected void	resetSize(int width, int height) Reset the size of the widget component.
void	set(java.lang.String property, java.lang.String value) Set an attribute value for this widget as a String.
void	setComponent(javax.swing.JComponent comp)
void	setFunctionBinding(java.lang.String actionType, FunctionBinding binding) Set a binding to a function.
void	setStyle(java.lang.String style) Set the style attribute for the widget.
void	setStyleClasses(java.util.Set<CSSSelector> styleClasses) Set the style classes for the widget.
void	setToolTipText(java.lang.String tooltiptext) Set the tooltip text when encountering the tooltip attribute.
protected XULCommandEvent	wrapActionEvent(java.awt.event.ActionEvent evt) Wrap an AWT ActionEvent.
protected XULAdjustmentEvent	wrapAdjustmentEvent(java.awt.event.AdjustmentEvent evt) Wrap an AWT AdjustmentEvent.
protected XULChangeEvent	wrapChangeEvent(java.awt.event.ActionEvent evt) Wrap an AWT ActionEvent.
protected XULChangeEvent	wrapChangeEvent(javax.swing.event.ChangeEvent evt) Wrap an AWT ChangeEvent.
protected XULChangeEvent	wrapChangeEvent(XULTreeCell cell, javax.swing.event.TableModelEvent evt) Wrap a TableModelEvent.
protected XULChangeEvent	wrapChangeEvent(XULTreeItem item, javax.swing.event.TableModelEvent evt) Wrap a TableModelEvent.
protected XULChangeEvent	wrapDocumentEvent(javax.swing.JComponent source, javax.swing.event.DocumentEvent evt) Wrap a DocumentEvent.
protected XULHoverEvent	wrapHoverEvent(java.awt.event.MouseEvent evt) Wrap an AWT MouseEntered.
protected XULExitEvent	wrapOutEvent(java.awt.event.MouseEvent evt) Wrap an AWT MouseEsit.
protected XULSelectedEvent	wrapSelectedEvent(javax.swing.event.ListSelectionEvent evt) Wrap an AWT ListSelectionEvent.

Methods inherited from class org.xul.script.xul.model.AbstractXULElement

addAttribute, getAlignmentFromNode, getAttrValueAsBoolean, getAttrValueAsBoolean, getAttrValueAsDimension, getAttrValueAsDouble, getAttrValueAsIcon, getAttrValueAsInteger, getComponent, getElement, getID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xul.script.xul.model.XULWidget

applyStyles, bindClickAction, bindLoadAction, canAddToHierarchy, cloneWidget, finishConstruction, getOnLoad, getParentElement, getPreferredSize, getSizedComponent, hasChildren, isEmptyContructionElement

Methods inherited from interface org.xul.script.xul.model.XULElement

getAttrValue, getComponent, getElement, getID, hasAttr

Field Detail

bindings

protected java.util.Map<java.lang.String,FunctionBinding> bindings

align

protected short align

The alignment.

Constructor Detail

AbstractXULWidget

public AbstractXULWidget()

AbstractXULWidget

public AbstractXULWidget(XULDocument document,
                         org.w3c.dom.Element elt)

Method Detail

getAlignment

public short getAlignment()

Return the alignment.

Specified by:

getAlignment in interface XULWidget

Returns:

the alignment

getStyleClasses

public java.util.Set<CSSSelector> getStyleClasses()

Return the style classes for the widget.

Specified by:

getStyleClasses in interface XULWidget

Returns:

the style classes for the widget

setStyleClasses

public void setStyleClasses(java.util.Set<CSSSelector> styleClasses)

Set the style classes for the widget.

Specified by:

setStyleClasses in interface XULWidget

Parameters:

styleClasses - the style classes for the widget

getStyle

public java.lang.String getStyle()

Return the style attribute for the widget.

Specified by:

getStyle in interface XULWidget

Returns:

the style attribute for the widget

setStyle

public void setStyle(java.lang.String style)

Set the style attribute for the widget.

Specified by:

setStyle in interface XULWidget

Parameters:

style - the style attribute for the widget

setComponent

public void setComponent(javax.swing.JComponent comp)

getDocument

public XULDocument getDocument()

Return the document.

Specified by:

getDocument in interface XULElement

Overrides:

getDocument in class AbstractXULElement

Returns:

the document

setFunctionBinding

public void setFunctionBinding(java.lang.String actionType,
                               FunctionBinding binding)

Set a binding to a function.

Specified by:

setFunctionBinding in interface XULWidget

Parameters:

actionType - the action type

binding - the binding.

getFunctionBinding

public FunctionBinding getFunctionBinding(java.lang.String actionType)

Description copied from interface: XULWidget

Return the function bound to the widget action. Return null by default.

Specified by:

getFunctionBinding in interface XULWidget

Parameters:

actionType - the action type

Returns:

the function bound to the widget action

getWidgetType

public java.lang.String getWidgetType()

Return the widget type. The type is the node name in the tree, that is characteristic of the wdget type (for example: "button");

Specified by:

getWidgetType in interface XULWidget

Returns:

the widget type

getOnCommand

public java.lang.String getOnCommand()

Return the oncommand function name.

Specified by:

getOnCommand in interface XULWidget

Returns:

the oncommand function name

getOnMouseOver

public java.lang.String getOnMouseOver()

Return the onmouseover function name.

Specified by:

getOnMouseOver in interface XULWidget

Returns:

the onmouseover function name

getOnMouseOut

public java.lang.String getOnMouseOut()

Return the onmouseout function name.

Specified by:

getOnMouseOut in interface XULWidget

Returns:

the onmouseout function name

getOnSelect

public java.lang.String getOnSelect()

Return the onselect function name.

Specified by:

getOnSelect in interface XULWidget

Returns:

the onselect function name

getOnChange

public java.lang.String getOnChange()

Return the onchange function name.

Specified by:

getOnChange in interface XULWidget

Returns:

the onchange function name

bindChangeActionImpl

protected void bindChangeActionImpl(java.lang.String command)

Bind an "onchange" action without delegating to bindCommandAction(java.lang.String).

Parameters:

command - the onchange content

bindCommandAction

public void bindCommandAction(java.lang.String command)

Bind an "oncommand" action.

Specified by:

bindCommandAction in interface XULWidget

Parameters:

command - the onchange content

bindChangeAction

public void bindChangeAction(java.lang.String command)

Bind an "onchange" action.

Specified by:

bindChangeAction in interface XULWidget

Parameters:

command - the onchange content

bindMouseOverAction

public void bindMouseOverAction(java.lang.String command)

Bind an "onmouseover" action.

Specified by:

bindMouseOverAction in interface XULWidget

Parameters:

command - the onchange content

bindSelectAction

public void bindSelectAction(java.lang.String command)

Bind an "onmouseover" action.

Specified by:

bindSelectAction in interface XULWidget

Parameters:

command - the onchange content

bindMouseOutAction

public void bindMouseOutAction(java.lang.String command)

Bind an "onmouseover" action.

Specified by:

bindMouseOutAction in interface XULWidget

Parameters:

command - the onchange content

bindAnyAction

protected void bindAnyAction(java.lang.String actionType,
                             java.lang.String command)

Bind any kind of action.

Parameters:

actionType - the action type

command - the action

wrapDocumentEvent

protected XULChangeEvent wrapDocumentEvent(javax.swing.JComponent source,
                                           javax.swing.event.DocumentEvent evt)

Wrap a DocumentEvent.

Parameters:

source - the source

evt - the DocumentEventt

Returns:

the XULChangeEvent

wrapActionEvent

protected XULCommandEvent wrapActionEvent(java.awt.event.ActionEvent evt)

Wrap an AWT ActionEvent.

Parameters:

evt - the AWT ActionEvent

Returns:

the XULChangeEvent

wrapSelectedEvent

protected XULSelectedEvent wrapSelectedEvent(javax.swing.event.ListSelectionEvent evt)

Wrap an AWT ListSelectionEvent.

Parameters:

evt - the AWT ListSelectionEvent

Returns:

the XULSelectedEvent

wrapChangeEvent

protected XULChangeEvent wrapChangeEvent(java.awt.event.ActionEvent evt)

Wrap an AWT ActionEvent.

Parameters:

evt - the AWT ChangeEvent

Returns:

the XULChangeEvent

wrapChangeEvent

protected XULChangeEvent wrapChangeEvent(XULTreeItem item,
                                         javax.swing.event.TableModelEvent evt)

Wrap a TableModelEvent.

Parameters:

item - the tree item

evt - the TableModelEvent

Returns:

the XULChangeEvent

wrapChangeEvent

protected XULChangeEvent wrapChangeEvent(XULTreeCell cell,
                                         javax.swing.event.TableModelEvent evt)

Wrap a TableModelEvent.

Parameters:

cell - the tree cell

evt - the TableModelEvent

Returns:

the XULChangeEvent

wrapChangeEvent

protected XULChangeEvent wrapChangeEvent(javax.swing.event.ChangeEvent evt)

Wrap an AWT ChangeEvent.

Parameters:

evt - the AWT ChangeEvent

Returns:

the XULChangeEvent

wrapHoverEvent

protected XULHoverEvent wrapHoverEvent(java.awt.event.MouseEvent evt)

Wrap an AWT MouseEntered.

Parameters:

evt - the AWT MouseEvent

Returns:

the XULHoverEvent

wrapOutEvent

protected XULExitEvent wrapOutEvent(java.awt.event.MouseEvent evt)

Wrap an AWT MouseEsit.

Parameters:

evt - the AWT MouseEvent

Returns:

the XULHoverEvent

wrapAdjustmentEvent

protected XULAdjustmentEvent wrapAdjustmentEvent(java.awt.event.AdjustmentEvent evt)

Wrap an AWT AdjustmentEvent.

Parameters:

evt - the AWT AdjustmentEvent

Returns:

the XULAdjustmentEvent

setToolTipText

public void setToolTipText(java.lang.String tooltiptext)

Set the tooltip text when encountering the tooltip attribute.

Specified by:

setToolTipText in interface XULWidget

Parameters:

tooltiptext - the tooltip text

get

public java.lang.Object get(java.lang.String property)

Return the value of a property.

Specified by:

get in interface XULElement

Overrides:

get in class AbstractXULElement

Parameters:

property - the property name

Returns:

the property value

set

public void set(java.lang.String property,
                java.lang.String value)

Set an attribute value for this widget as a String.

Specified by:

set in interface XULElement

Parameters:

property - the property name

value - the property value

resetSize

protected void resetSize(int width,
                         int height)

Reset the size of the widget component.

Parameters:

width - the widht

height - the height

resetMaximumSize

protected void resetMaximumSize(java.awt.Dimension d)

Reset the maximum size of the widget component.

Parameters:

d - the dimension

resetMinimumSize

protected void resetMinimumSize(java.awt.Dimension d)

Reset the minimum size of the widget component.

Parameters:

d - the dimension

resetPosition

protected void resetPosition(int left,
                             int top)

Reset the position of the widget component.

Parameters:

left - the left position

top - the top position

jsSet_tooltiptext

public void jsSet_tooltiptext(java.lang.String value)

jsSet_class

public void jsSet_class(java.lang.String value)

reapplyStyle

protected void reapplyStyle(short pseudoClass)

reapplyStyle

protected void reapplyStyle()

jsSet_style

public void jsSet_style(java.lang.String value)

jsSet_width

public void jsSet_width(java.lang.String value)

jsSet_height

public void jsSet_height(java.lang.String value)

jsSet_hidden

public void jsSet_hidden(java.lang.String value)

jsSet_left

public void jsSet_left(java.lang.String value)

jsSet_top

public void jsSet_top(java.lang.String value)