org.xul.script.xul.model

Class XULButton

java.lang.Object

org.xul.script.xul.model.AbstractXULElement

org.xul.script.xul.model.AbstractXULWidget

org.xul.script.xul.model.XULButton

All Implemented Interfaces:

XULConstants, XULElement, XULWidget

public class XULButton
extends AbstractXULWidget

The model for a XUL button, toolbarbutton, and radiobutton widgets. It also handle buttons which have the attribute type positionned to "checkbox" or "radio". Example:

    <button label="basic button" left="5" top="5"/>
    <button label="basic button with image" image="anImage.gif" left="50" top="5"/>
    <button label="checkbox button" type="checkbox" left="5" top="30"/>
    <button label="radio button" type="radio" left="5" top="50"/>
    <toolbarbutton id="toolbar button" image="anImage.png"
                      oncommand="aJavaScriptCommand()" top="70" left="70"/>
    <radiogroup top="100" left="20">
      <radio label="first" />
      <radio label="second" />
      <radio label="third" />
    </radiogroup>
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_CHECKBOX
static int	TYPE_MENU
static int	TYPE_RADIO
static int	TYPE_REGULAR
static int	TYPE_TOOLBAR

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

align, 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
XULButton(XULDocument document, org.w3c.dom.Element elt)
XULButton(XULDocument document, org.w3c.dom.Element elt, int buttonType)

Method Summary

Modifier and Type	Method and Description
boolean	applyStyles(CSSStyles.Rules rules) Apply the styles on the widget.
void	bindClickAction(java.lang.String onclick) Bind an "onclick" action.
void	bindCommandAction(java.lang.String onCommand) Bind an "oncommand" action.
XULButton	cloneWidget() Clone the widget.
java.lang.Object	get(java.lang.String property) Return the value of a property.
int	getButtonType()
javax.swing.AbstractButton	getComponent() Return the associated Swing component.
void	jsSet_checked(java.lang.String value)
void	jsSet_disabled(java.lang.String value)
void	jsSet_image(java.lang.String value)
void	jsSet_label(java.lang.String value)
void	set(java.lang.String property, java.lang.String value) Set an attribute value for this widget as a String.

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

bindAnyAction, bindChangeAction, bindChangeActionImpl, bindMouseOutAction, bindMouseOverAction, bindSelectAction, getAlignment, getDocument, getFunctionBinding, getOnChange, getOnCommand, getOnMouseOut, getOnMouseOver, getOnSelect, getStyle, getStyleClasses, getWidgetType, jsSet_class, jsSet_height, jsSet_hidden, jsSet_left, jsSet_style, jsSet_tooltiptext, jsSet_top, jsSet_width, reapplyStyle, reapplyStyle, resetMaximumSize, resetMinimumSize, resetPosition, resetSize, setComponent, setFunctionBinding, setStyle, setStyleClasses, setToolTipText, wrapActionEvent, wrapAdjustmentEvent, wrapChangeEvent, wrapChangeEvent, wrapChangeEvent, wrapChangeEvent, wrapDocumentEvent, wrapHoverEvent, wrapOutEvent, wrapSelectedEvent

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

addAttribute, getAlignmentFromNode, getAttrValueAsBoolean, getAttrValueAsBoolean, getAttrValueAsDimension, getAttrValueAsDouble, getAttrValueAsIcon, getAttrValueAsInteger, 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

bindLoadAction, canAddToHierarchy, finishConstruction, getOnLoad, getParentElement, getPreferredSize, getSizedComponent, hasChildren, isEmptyContructionElement

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

getAttrValue, getElement, getID, hasAttr

Field Detail

TYPE_REGULAR

public static final int TYPE_REGULAR

See Also:

Constant Field Values

TYPE_TOOLBAR

public static final int TYPE_TOOLBAR

See Also:

Constant Field Values

TYPE_RADIO

public static final int TYPE_RADIO

See Also:

Constant Field Values

TYPE_CHECKBOX

public static final int TYPE_CHECKBOX

See Also:

Constant Field Values

TYPE_MENU

public static final int TYPE_MENU

See Also:

Constant Field Values

Constructor Detail

XULButton

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

XULButton

public XULButton(XULDocument document,
                 org.w3c.dom.Element elt,
                 int buttonType)

Method Detail

cloneWidget

public XULButton cloneWidget()

Description copied from interface: XULWidget

Clone the widget.

Returns:

null by default

getButtonType

public int getButtonType()

getComponent

public javax.swing.AbstractButton getComponent()

Description copied from interface: XULElement

Return the associated Swing component.

Specified by:

getComponent in interface XULElement

Overrides:

getComponent in class AbstractXULElement

Returns:

the associated Swing component

applyStyles

public boolean applyStyles(CSSStyles.Rules rules)

Apply the styles on the widget.

Parameters:

rules - the CSS rules applied to this widget

Returns:

true if the vertical alignment of the widget has been set

bindCommandAction

public void bindCommandAction(java.lang.String onCommand)

Description copied from class: AbstractXULWidget

Bind an "oncommand" action.

Specified by:

bindCommandAction in interface XULWidget

Overrides:

bindCommandAction in class AbstractXULWidget

Parameters:

onCommand - the onchange content

bindClickAction

public void bindClickAction(java.lang.String onclick)

Description copied from interface: XULWidget

Bind an "onclick" action. The command is the call of a function or method. Do nothing by default. For example:

 button.bindClickAction("clicked()");
 

Parameters:

onclick - the onchange content

get

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

Description copied from class: AbstractXULWidget

Return the value of a property.

Specified by:

get in interface XULElement

Overrides:

get in class AbstractXULWidget

Parameters:

property - the property name

Returns:

the property value

set

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

Description copied from class: AbstractXULWidget

Set an attribute value for this widget as a String.

Specified by:

set in interface XULElement

Overrides:

set in class AbstractXULWidget

Parameters:

property - the property name

value - the property value

jsSet_label

public void jsSet_label(java.lang.String value)

jsSet_disabled

public void jsSet_disabled(java.lang.String value)

jsSet_checked

public void jsSet_checked(java.lang.String value)

jsSet_image

public void jsSet_image(java.lang.String value)