to.etc.domui.component.buttons

Class DefaultButton

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.Button

to.etc.domui.component.buttons.DefaultButton

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IActionControl

public class DefaultButton
extends Button
implements IActionControl

The default button for DomUI renders a sliding doors button that can contain a text and an icon. The button is fully styled through CSS. The rendered structure is as follows:

        <button type='button' class='ui-sdbtn' onclick=... accesskey=...>
                <span>
                        <img src="icon" border="0">
                        <u>l</u>abel text
                <span>
        </button>
 

Author:

Frits Jalvingh Created on Jun 3, 2011

Constructor Summary

Constructors

Constructor and Description
DefaultButton() Create an empty button.
DefaultButton(IUIAction<?> action) Create a IUIAction based button.
DefaultButton(String txt) Create a button with a text.
DefaultButton(String txt, IClicked<DefaultButton> clicked)
DefaultButton(String txt, String icon) Create a button with a text and an icon.
DefaultButton(String txt, String icon, IClicked<DefaultButton> clicked)
DefaultButton(T instance, IUIAction<T> action) Create a IUIAction based button.

Method Summary

Modifier and Type	Method and Description
void	createContent()
IUIAction<?>	getAction() EXPERIMENTAL - UNSTABLE INTERFACE - Get the action associated with this button, or null if the button is not action based.
String	getComponentInfo()
String	getIcon()
String	getText() Returns the text currently set on the button.
DefaultButton	mini() Define this as a "mini" button, usable to be added inside a table row.
void	setDisabled(boolean disabled) Set the input to disabled mode.
void	setIcon(String name) Sets a (new) icon on this button.
void	setIconImage(Class<?> resourceBase, String name) Uses a resource as the base for the image.
void	setText(String text) Set a (new) text on the button's surface.

Methods inherited from class to.etc.domui.dom.html.Button

getAccessKey, getButtonValue, getDisabledBecause, getType, isDisabled, setAccessKey, setButtonValue, setDisabled, setDisabledBecause, setType, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebAction, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setTestID

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultButton

public DefaultButton()

Create an empty button.

DefaultButton

public DefaultButton(String txt)

Create a button with a text.

Parameters:

txt -

DefaultButton

public DefaultButton(IUIAction<?> action)
              throws Exception

Create a IUIAction based button.

Parameters:

txt -

Throws:

Exception

DefaultButton

public DefaultButton(T instance,
                     IUIAction<T> action)
              throws Exception

Create a IUIAction based button.

Parameters:

txt -

Throws:

Exception

DefaultButton

public DefaultButton(String txt,
                     String icon)

Create a button with a text and an icon.

Parameters:

txt -

icon -

DefaultButton

public DefaultButton(String txt,
                     IClicked<DefaultButton> clicked)

DefaultButton

public DefaultButton(String txt,
                     String icon,
                     IClicked<DefaultButton> clicked)

Method Detail

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

mini

public DefaultButton mini()

Define this as a "mini" button, usable to be added inside a table row.

Returns:

setIconImage

public void setIconImage(Class<?> resourceBase,
                         String name)

Uses a resource as the base for the image.

Parameters:

resourceBase - The base location for the specified name. Name is resolved with this class as the base.

name - The resource's name relative to the class.

setIcon

public void setIcon(@Nullable
                    String name)

Sets a (new) icon on this button. This requires an absolute image path.

Parameters:

name -

getIcon

@Nullable
public String getIcon()

getText

public String getText()

Returns the text currently set on the button.

Returns:

setText

public void setText(@Nullable
                    String text)

Set a (new) text on the button's surface. The text may contain a '!' to specify an accelerator. To actually render the exclamation point precede it with a backslash.

Overrides:

setText in class NodeContainer

See Also:

NodeContainer.setText(java.lang.String)

getComponentInfo

public String getComponentInfo()

Overrides:

getComponentInfo in class NodeBase

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

Overrides:

setDisabled in class Button

getAction

@Nullable
public IUIAction<?> getAction()

EXPERIMENTAL - UNSTABLE INTERFACE - Get the action associated with this button, or null if the button is not action based.

Returns: