XULWidget

All Superinterfaces:

XULElement

All Known Implementing Classes:

AbstractEmptyXULWidget, AbstractXULMenuParent, AbstractXULWidget, XULButton, XULCheckBox, XULContainer, XULFileField, XULImage, XULLabel, XULListBox, XULListCell, XULListItem, XULMenu, XULMenuBar, XULMenuButton, XULMenuItem, XULMenuList, XULMenuPopup, XULMenuSeparator, XULProgressMeter, XULScale, XULScrollBar, XULSpacer, XULStack, XULTab, XULTabBox, XULTabBox.XULTabPanels, XULTabBox.XULTabs, XULTabPanel, XULTextBox, XULToolbar, XULToolbarItem, XULToolbarSpacer, XULToolbox, XULTree, XULTreeCell, XULTreeCol, XULTreeItem, XULWindow
```
public interface XULWidget
extends XULElement
```
Represents a XUL Widget in a XUL Script. Allows to get or ser properties as Strings.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`applyStyles(CSSStyles.Rules rules)` Apply the styles on the widget.
`default void`	`bindChangeAction(java.lang.String command)` Bind an "oncommand" action.
`default void`	`bindClickAction(java.lang.String command)` Bind an "onclick" action.
`default void`	`bindCommandAction(java.lang.String command)` Bind an "oncommand" action.
`default void`	`bindLoadAction(java.lang.String command)` Bind an "onload" action.
`default void`	`bindMouseOutAction(java.lang.String command)` Bind an "onmouseout" action.
`default void`	`bindMouseOverAction(java.lang.String command)` Bind an "onmouseover" action.
`default void`	`bindSelectAction(java.lang.String command)` Bind an "onselect" action.
`default boolean`	`canAddToHierarchy()` Return true if the widget can be added to to swing hierarchy.
`default XULWidget`	`cloneWidget()` Clone the widget.
`default void`	`finishConstruction()` Finish the construction of the widget.
`default short`	`getAlignment()` Return the alignment.
`default FunctionBinding`	`getFunctionBinding(java.lang.String actionType)` Return the function bound to the widget action.
`default java.lang.String`	`getOnChange()` Return the onchange function name.
`default java.lang.String`	`getOnCommand()` Return the oncommand function name.
`default java.lang.String`	`getOnLoad()` Return the onload function name.
`default java.lang.String`	`getOnMouseOut()` Return the onmouseout function name.
`default java.lang.String`	`getOnMouseOver()` Return the onmouseover function name.
`default java.lang.String`	`getOnSelect()` Return the onselect function name.
`default org.w3c.dom.Element`	`getParentElement()` Return the effective parent element.
`default java.awt.Dimension`	`getPreferredSize()` Return the preferred size of the widget.
`default javax.swing.JComponent`	`getSizedComponent()` Return the associated Swing component which must be used foer the `getPreferredSize()` method.
`default java.lang.String`	`getStyle()` Return the style attribute for the widget.
`default java.util.Set<CSSSelector>`	`getStyleClasses()` Return the style classes for the widget.
`java.lang.String`	`getWidgetType()` Return the widget type.
`default boolean`	`hasChildren()` Return true if the widget has children.
`default boolean`	`isEmptyContructionElement()` Return true if the widget is an empty construction element.
`default void`	`setFunctionBinding(java.lang.String actionType, FunctionBinding binding)` Set a binding to a function.
`default void`	`setStyle(java.lang.String style)` Set the style attribute for the widget.
`default void`	`setStyleClasses(java.util.Set<CSSSelector> styleClasses)` Set the style classes for the widget.
`default void`	`setToolTipText(java.lang.String tooltiptext)` Set the tooltip text when encountering the tooltip attribute.

Methods inherited from interface org.xul.script.xul.model.XULElement
get, getAttrValue, getComponent, getDocument, getElement, getID, hasAttr, set

- Method Detail
  - getWidgetType
```
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");
    
    Returns:
    
    the widget type
  - getSizedComponent
```
default javax.swing.JComponent getSizedComponent()
```
    Return the associated Swing component which must be used foer the getPreferredSize() method.
    
    Returns:
    
    the Swing component
  - canAddToHierarchy
```
default boolean canAddToHierarchy()
```
    Return true if the widget can be added to to swing hierarchy. Return true by default.
    
    Returns:
    
    true if the widget can be added to to swing hierarchy
  - finishConstruction
```
default void finishConstruction()
```
    Finish the construction of the widget.
  - cloneWidget
```
default XULWidget cloneWidget()
```
    Clone the widget.
    
    Returns:
    
    null by default
  - getPreferredSize
```
default java.awt.Dimension getPreferredSize()
```
    Return the preferred size of the widget.
    
    Returns:
    
    the preferred size
  - getParentElement
```
default org.w3c.dom.Element getParentElement()
```
    Return the effective parent element. Return the parent element node by default.
    
    Returns:
    
    the effective parent element
  - isEmptyContructionElement
```
default boolean isEmptyContructionElement()
```
    Return true if the widget is an empty construction element. Return false by default.
    
    Returns:
    
    true if the widget is an empty construction element
  - hasChildren
```
default boolean hasChildren()
```
    Return true if the widget has children. Return false by default.
    
    Returns:
    
    true if the widget has children
  - getAlignment
```
default short getAlignment()
```
    Return the alignment.
    
    Returns:
    
    the alignment
  - setFunctionBinding
```
default void setFunctionBinding(java.lang.String actionType,
                                FunctionBinding binding)
```
    Set a binding to a function.
    
    Parameters:
    
    actionType - the action type
    
    binding - the binding.
  - getFunctionBinding
```
default FunctionBinding getFunctionBinding(java.lang.String actionType)
```
    Return the function bound to the widget action. Return null by default.
    
    Parameters:
    
    actionType - the action type
    
    Returns:
    
    the function bound to the widget action
  - getStyleClasses
```
default java.util.Set<CSSSelector> getStyleClasses()
```
    Return the style classes for the widget. Return null by default.
    
    Returns:
    
    the style classes for the widget
  - setStyleClasses
```
default void setStyleClasses(java.util.Set<CSSSelector> styleClasses)
```
    Set the style classes for the widget. Do nothing by default.
    
    Parameters:
    
    styleClasses - the style classes for the widget
  - getStyle
```
default java.lang.String getStyle()
```
    Return the style attribute for the widget. Return null by default.
    
    Returns:
    
    the style attribute for the widget
  - setStyle
```
default void setStyle(java.lang.String style)
```
    Set the style attribute for the widget. Do nothing by default.
    
    Parameters:
    
    style - the style attribute for the widget
  - setToolTipText
```
default void setToolTipText(java.lang.String tooltiptext)
```
    Set the tooltip text when encountering the tooltip attribute. Do nothing by default.
    
    Parameters:
    
    tooltiptext - the tooltip text
  - bindCommandAction
```
default void bindCommandAction(java.lang.String command)
```
    Bind an "oncommand" action. The command is the call of a function or method. Do nothing by default. For example:
```
 button.bindCommandAction("clicked()");
 
```
    Parameters:
    
    command - the onchange content
  - bindMouseOverAction
```
default void bindMouseOverAction(java.lang.String command)
```
    Bind an "onmouseover" action. The command is the call of a function or method. Do nothing by default. For example:
```
 label.bindMouseOverAction("hover()");
 
```
    Parameters:
    
    command - the onmouseover content
  - bindMouseOutAction
```
default void bindMouseOutAction(java.lang.String command)
```
    Bind an "onmouseout" action. The command is the call of a function or method. Do nothing by default. For example:
```
 label.bindMouseOutAction("exit()");
 
```
    Parameters:
    
    command - the onmouseover content
  - bindSelectAction
```
default void bindSelectAction(java.lang.String command)
```
    Bind an "onselect" action. The command is the call of a function or method. Do nothing by default. For example:
```
 lsitbox.bindSelectAction("select()");
 
```
    Parameters:
    
    command - the onmouseover content
  - bindChangeAction
```
default void bindChangeAction(java.lang.String command)
```
    Bind an "oncommand" action. Do nothing by default. For example:
```
 scale.bindChangeAction("moved()");
 
```
    Parameters:
    
    command - the onchange content
  - bindClickAction
```
default void bindClickAction(java.lang.String command)
```
    Bind an "onclick" action. The command is the call of a function or method. Do nothing by default. For example:
```
 button.bindClickAction("clicked()");
 
```
    Parameters:
    
    command - the onchange content
  - bindLoadAction
```
default void bindLoadAction(java.lang.String command)
```
    Bind an "onload" action. The command is the call of a function or method. Do nothing by default. For example:
```
 window.bindLoadAction("loaded()");
 
```
    Parameters:
    
    command - the onload content
  - getOnCommand
```
default java.lang.String getOnCommand()
```
    Return the oncommand function name. Return null by default.
    
    Returns:
    
    the oncommand function name
  - getOnMouseOver
```
default java.lang.String getOnMouseOver()
```
    Return the onmouseover function name. Return null by default.
    
    Returns:
    
    the onmouseover function name
  - getOnMouseOut
```
default java.lang.String getOnMouseOut()
```
    Return the onmouseout function name. Return null by default.
    
    Returns:
    
    the onmouseout function name
  - getOnSelect
```
default java.lang.String getOnSelect()
```
    Return the onselect function name. Return null by default.
    
    Returns:
    
    the onselect function name
  - getOnChange
```
default java.lang.String getOnChange()
```
    Return the onchange function name. Return null by default.
    
    Returns:
    
    the oncommand function name
  - getOnLoad
```
default java.lang.String getOnLoad()
```
    Return the onload function name. Return null by default.
    
    Returns:
    
    the onload function name
  - applyStyles
```
default boolean applyStyles(CSSStyles.Rules rules)
```
    Apply the styles on the widget. Do nothing and return false by default.
    
    Parameters:
    
    rules - the CSS rules applied to this widget
    
    Returns:
    
    true if the vertical alignment of the widget has been set

Interface XULWidget

Method Summary

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

Method Detail

getWidgetType

getSizedComponent

canAddToHierarchy

finishConstruction

cloneWidget

getPreferredSize

getParentElement

isEmptyContructionElement

hasChildren

getAlignment

setFunctionBinding

getFunctionBinding

getStyleClasses

setStyleClasses

getStyle

setStyle

setToolTipText

bindCommandAction

bindMouseOverAction

bindMouseOutAction

bindSelectAction

bindChangeAction

bindClickAction

bindLoadAction

getOnCommand

getOnMouseOver

getOnMouseOut

getOnSelect

getOnChange

getOnLoad

applyStyles