ButtonBase

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.rave.web.ui.component
Class ButtonBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.sun.rave.web.ui.component.ButtonBase

All Implemented Interfaces:: javax.faces.component.ActionSource, javax.faces.component.StateHolder

Direct Known Subclasses:: Button

public abstract class ButtonBase
extends javax.faces.component.UICommand

Use the ui:button tag to display an input button in the rendered HTML page. The input button submits the associated form when activated by the user. The corresponding ActionEvent events then occur on the server.

HTML Elements and Layout

This tag uses the XHTML <input> element to create a button with a text label.

Client Side Javascript Functions

The button component supports a client side javascript object. To use this object all you need to do is get the object by using document.getElementById() function to get the object. It is recommended though you pass the result of the getElementById() function to a local variable rather than accessing the functions directly. The object supports the following functions:

isMini(): Test if button style is "mini" for the button. Returns a boolean.
isPrimary(): Test if button style is "primary" for the button. Returns a boolean.
isSecondary(): DEPRECATED use isPrimary instead Test if button style is "secondary" for the button. Returns a boolean.
setMini(mini): Set button style to "mini" for the button. If the mini attribute is set to true, the element is shown with mini styles.
setPrimary(primary): Set button style to "primary" for the given button. If the primary attribute is set to true, the element is shown with primary style.
setSecondary(secondary): DEPRECATED use setPrimary instead Set button style to "secondary" for the given button. If the secondary attribute is set to true, the element is shown with secondary styles.

There are two other common functions that are useful for a button.

common_stripStyleClass(javascriptObj, classToRemove): Use this function to remove a style class from a any js object that supports the class property. Takes a javascript object and the style class string to remove.
common_addStyleClass(this, newType): Use this function to add a new style class to any js object that supports the class property. Takes a javascript object and the style class string to add.

Examples

Example 1: Create a primary button:

<ui:button
 id="button1" text="#{ButtonBean.text}"
 action="#{ButtonBean.success}" />

Example 2: Create a primary mini button:

<ui:button
 id="button1" text="#{ButtonBean.text}"
 action="#{ButtonBean.success}" mini="true" />

Example 3: Create a secondary button:

<ui:button
 id="button1" text="#{ButtonBean.text}"
 action="#{ButtonBean.success}" secondary="true" />

Example 4: Create a secondary mini button:

<ui:button
 id="button1" text="#{ButtonBean.text}"
 action="#{ButtonBean.success}" secondary="true" isMini="true" />

Example 5: Create a reset button:

<ui:button
 id="button1"
 text="#{ButtonBean.text}" action="#{ButtonBean.success}" reset="true"
 />

Example 6: Create an image button:

<ui:button
 id="button1" imageURL="#{ButtonBean.image}"
 action="#{ButtonBean.success}" />

Auto-generated component class. Do NOT modify; all changes will be lost!

Field Summary

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary
`ButtonBase()` Construct a new `ButtonBase`.

Method Summary
`javax.faces.el.MethodBinding`	`getAction()` Method binding representing a method that processes application actions from this component.
`javax.faces.el.MethodBinding`	`getActionListener()` Method binding representing a method that receives action from this, and possibly other, components.
`java.lang.String`	`getAlt()` Alternative text description used by screen reader tools
`java.lang.String`	`getFamily()` Return the family for this component.
`java.lang.String`	`getImageURL()` Resource path of an image to be displayed to create the visual appearance of this button instead of the standard button image.
`java.lang.String`	`getOnBlur()` Scripting code executed when this element loses focus.
`java.lang.String`	`getOnClick()` Scripting code executed when a mouse click occurs over this component.
`java.lang.String`	`getOnDblClick()` Scripting code executed when a mouse double click occurs over this component.
`java.lang.String`	`getOnFocus()` Scripting code executed when this component receives focus.
`java.lang.String`	`getOnKeyDown()` Scripting code executed when the user presses down on a key while the component has focus.
`java.lang.String`	`getOnKeyPress()` Scripting code executed when the user presses and releases a key while the component has focus.
`java.lang.String`	`getOnKeyUp()` Scripting code executed when the user releases a key while the component has focus.
`java.lang.String`	`getOnMouseDown()` Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
`java.lang.String`	`getOnMouseMove()` Scripting code executed when the user moves the mouse pointer while over the component.
`java.lang.String`	`getOnMouseOut()` Scripting code executed when a mouse out movement occurs over this component.
`java.lang.String`	`getOnMouseOver()` Scripting code executed when the user moves the mouse pointer into the boundary of this component.
`java.lang.String`	`getOnMouseUp()` Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
`java.lang.String`	`getStyle()` CSS style(s) to be applied when this component is rendered.
`java.lang.String`	`getStyleClass()` CSS style class(es) to be applied when this component is rendered.
`int`	`getTabIndex()` The position of this component in the tabbing order sequence
`java.lang.Object`	`getText()` Textual label used to create the visual appearance of this button.
`java.lang.String`	`getToolTip()` Display the text as a tooltip for this component
`javax.faces.el.ValueBinding`	`getValueBinding(java.lang.String name)` Return the `ValueBinding` stored for the specified name (if any), respecting any property aliases.
`boolean`	`isDisabled()` Indicates that activation of this component by the user is not currently permitted.
`boolean`	`isEscape()` Escape HTML markup in the button text
`boolean`	`isMini()` Indicates that the button should be rendered using a different style than normal buttons.
`boolean`	`isNoTextPadding()` Indicates that padding should not be applied to the button text.
`boolean`	`isPrimary()` Indicates that the button is the most commonly used button within a group.
`boolean`	`isReset()` Indicates that the button should be a HTML reset button.
`boolean`	`isVisible()` Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
`void`	`restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)` Restore the state of this component.
`java.lang.Object`	`saveState(javax.faces.context.FacesContext _context)` Save the state of this component.
`void`	`setAction(javax.faces.el.MethodBinding action)` Method binding representing a method that processes application actions from this component.
`void`	`setActionListener(javax.faces.el.MethodBinding actionListener)` Method binding representing a method that receives action from this, and possibly other, components.
`void`	`setAlt(java.lang.String alt)` Alternative text description used by screen reader tools
`void`	`setDisabled(boolean disabled)` Indicates that activation of this component by the user is not currently permitted.
`void`	`setEscape(boolean escape)` Escape HTML markup in the button text
`void`	`setImageURL(java.lang.String imageURL)` Resource path of an image to be displayed to create the visual appearance of this button instead of the standard button image.
`void`	`setMini(boolean mini)` Indicates that the button should be rendered using a different style than normal buttons.
`void`	`setNoTextPadding(boolean noTextPadding)` Indicates that padding should not be applied to the button text.
`void`	`setOnBlur(java.lang.String onBlur)` Scripting code executed when this element loses focus.
`void`	`setOnClick(java.lang.String onClick)` Scripting code executed when a mouse click occurs over this component.
`void`	`setOnDblClick(java.lang.String onDblClick)` Scripting code executed when a mouse double click occurs over this component.
`void`	`setOnFocus(java.lang.String onFocus)` Scripting code executed when this component receives focus.
`void`	`setOnKeyDown(java.lang.String onKeyDown)` Scripting code executed when the user presses down on a key while the component has focus.
`void`	`setOnKeyPress(java.lang.String onKeyPress)` Scripting code executed when the user presses and releases a key while the component has focus.
`void`	`setOnKeyUp(java.lang.String onKeyUp)` Scripting code executed when the user releases a key while the component has focus.
`void`	`setOnMouseDown(java.lang.String onMouseDown)` Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
`void`	`setOnMouseMove(java.lang.String onMouseMove)` Scripting code executed when the user moves the mouse pointer while over the component.
`void`	`setOnMouseOut(java.lang.String onMouseOut)` Scripting code executed when a mouse out movement occurs over this component.
`void`	`setOnMouseOver(java.lang.String onMouseOver)` Scripting code executed when the user moves the mouse pointer into the boundary of this component.
`void`	`setOnMouseUp(java.lang.String onMouseUp)` Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
`void`	`setPrimary(boolean primary)` Indicates that the button is the most commonly used button within a group.
`void`	`setReset(boolean reset)` Indicates that the button should be a HTML reset button.
`void`	`setStyle(java.lang.String style)` CSS style(s) to be applied when this component is rendered.
`void`	`setStyleClass(java.lang.String styleClass)` CSS style class(es) to be applied when this component is rendered.
`void`	`setTabIndex(int tabIndex)` The position of this component in the tabbing order sequence
`void`	`setText(java.lang.Object text)` Textual label used to create the visual appearance of this button.
`void`	`setToolTip(java.lang.String toolTip)` Display the text as a tooltip for this component
`void`	`setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding)` Set the `ValueBinding` stored for the specified name (if any), respecting any property aliases.
`void`	`setVisible(boolean visible)` Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonBase

public ButtonBase()

Construct a new ButtonBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getValueBinding

public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)

Return the ValueBinding stored for the specified name (if any), respecting any property aliases.

Parameters:: name - Name of value binding to retrieve

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

Set the ValueBinding stored for the specified name (if any), respecting any property aliases.

Parameters:: name - Name of value binding to set; binding - ValueBinding to set, or null to remove

getAction

public javax.faces.el.MethodBinding getAction()

Method binding representing a method that processes application actions from this component.

setAction

public void setAction(javax.faces.el.MethodBinding action)

Method binding representing a method that processes application actions from this component.

See Also:: getAction()

getActionListener

public javax.faces.el.MethodBinding getActionListener()

Method binding representing a method that receives action from this, and possibly other, components.

setActionListener

public void setActionListener(javax.faces.el.MethodBinding actionListener)

Method binding representing a method that receives action from this, and possibly other, components.

See Also:: getActionListener()

getAlt

public java.lang.String getAlt()

Alternative text description used by screen reader tools

setAlt

public void setAlt(java.lang.String alt)

Alternative text description used by screen reader tools

See Also:: getAlt()

isDisabled

public boolean isDisabled()

Indicates that activation of this component by the user is not currently permitted. In this component library, the disabled attribute also causes the button to be renderered using a particular style.

setDisabled

public void setDisabled(boolean disabled)

Indicates that activation of this component by the user is not currently permitted. In this component library, the disabled attribute also causes the button to be renderered using a particular style.

See Also:: isDisabled()

isEscape

public boolean isEscape()

Escape HTML markup in the button text

setEscape

public void setEscape(boolean escape)

Escape HTML markup in the button text

See Also:: isEscape()

getImageURL

public java.lang.String getImageURL()

Resource path of an image to be displayed to create the visual appearance of this button instead of the standard button image. Either the "imageURL" or "text" attributes must be specified. When an imageURL value is given, the button type is set to "image".

setImageURL

public void setImageURL(java.lang.String imageURL)

See Also:: getImageURL()

isMini

public boolean isMini()

Indicates that the button should be rendered using a different style than normal buttons. If the value is set to true, the button shall appear somewhat smaller than a normal button. Mini buttons are useful in situations where a button applies to an individual field on the page, rather than a section, table, or whole page.

setMini

public void setMini(boolean mini)

See Also:: isMini()

isNoTextPadding

public boolean isNoTextPadding()

Indicates that padding should not be applied to the button text. By default, whitespace characters are padded to button text greater than or equal to 4 characters in length. If the value is set to true, no padding is applied.

setNoTextPadding

public void setNoTextPadding(boolean noTextPadding)

See Also:: isNoTextPadding()

getOnBlur

public java.lang.String getOnBlur()

Scripting code executed when this element loses focus.

setOnBlur

public void setOnBlur(java.lang.String onBlur)

Scripting code executed when this element loses focus.

See Also:: getOnBlur()

getOnClick

public java.lang.String getOnClick()

Scripting code executed when a mouse click occurs over this component.

setOnClick

public void setOnClick(java.lang.String onClick)

Scripting code executed when a mouse click occurs over this component.

See Also:: getOnClick()

getOnDblClick

public java.lang.String getOnDblClick()

Scripting code executed when a mouse double click occurs over this component.

setOnDblClick

public void setOnDblClick(java.lang.String onDblClick)

Scripting code executed when a mouse double click occurs over this component.

See Also:: getOnDblClick()

getOnFocus

public java.lang.String getOnFocus()

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

setOnFocus

public void setOnFocus(java.lang.String onFocus)

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

See Also:: getOnFocus()

getOnKeyDown

public java.lang.String getOnKeyDown()

Scripting code executed when the user presses down on a key while the component has focus.

setOnKeyDown

public void setOnKeyDown(java.lang.String onKeyDown)

Scripting code executed when the user presses down on a key while the component has focus.

See Also:: getOnKeyDown()

getOnKeyPress

public java.lang.String getOnKeyPress()

Scripting code executed when the user presses and releases a key while the component has focus.

setOnKeyPress

public void setOnKeyPress(java.lang.String onKeyPress)

Scripting code executed when the user presses and releases a key while the component has focus.

See Also:: getOnKeyPress()

getOnKeyUp

public java.lang.String getOnKeyUp()

Scripting code executed when the user releases a key while the component has focus.

setOnKeyUp

public void setOnKeyUp(java.lang.String onKeyUp)

Scripting code executed when the user releases a key while the component has focus.

See Also:: getOnKeyUp()

getOnMouseDown

public java.lang.String getOnMouseDown()

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

setOnMouseDown

public void setOnMouseDown(java.lang.String onMouseDown)

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

See Also:: getOnMouseDown()

getOnMouseMove

public java.lang.String getOnMouseMove()

Scripting code executed when the user moves the mouse pointer while over the component.

setOnMouseMove

public void setOnMouseMove(java.lang.String onMouseMove)

Scripting code executed when the user moves the mouse pointer while over the component.

See Also:: getOnMouseMove()

getOnMouseOut

public java.lang.String getOnMouseOut()

Scripting code executed when a mouse out movement occurs over this component.

setOnMouseOut

public void setOnMouseOut(java.lang.String onMouseOut)

Scripting code executed when a mouse out movement occurs over this component.

See Also:: getOnMouseOut()

getOnMouseOver

public java.lang.String getOnMouseOver()

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

setOnMouseOver

public void setOnMouseOver(java.lang.String onMouseOver)

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

See Also:: getOnMouseOver()

getOnMouseUp

public java.lang.String getOnMouseUp()

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

setOnMouseUp

public void setOnMouseUp(java.lang.String onMouseUp)

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

See Also:: getOnMouseUp()

isPrimary

public boolean isPrimary()

Indicates that the button is the most commonly used button within a group.

setPrimary

public void setPrimary(boolean primary)

Indicates that the button is the most commonly used button within a group.

See Also:: isPrimary()

isReset

public boolean isReset()

Indicates that the button should be a HTML reset button. By default, this value is false and the button is created as a submit button. If the value is set to true, no action listener will be invoked.

setReset

public void setReset(boolean reset)

Indicates that the button should be a HTML reset button. By default, this value is false and the button is created as a submit button. If the value is set to true, no action listener will be invoked.

See Also:: isReset()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:: getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:: getStyleClass()

getTabIndex

public int getTabIndex()

The position of this component in the tabbing order sequence

setTabIndex

public void setTabIndex(int tabIndex)

The position of this component in the tabbing order sequence

See Also:: getTabIndex()

getText

public java.lang.Object getText()

Textual label used to create the visual appearance of this button. Either the "imageURL" or "text" attributes must be specified. When a text value is given, the standard button image is used, with the specified text displayed on the button.

setText

public void setText(java.lang.Object text)

See Also:: getText()

getToolTip

public java.lang.String getToolTip()

Display the text as a tooltip for this component

setToolTip

public void setToolTip(java.lang.String toolTip)

Display the text as a tooltip for this component

See Also:: getToolTip()

isVisible

public boolean isVisible()

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

setVisible

public void setVisible(boolean visible)

See Also:: isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.rave.web.ui.component Class ButtonBase

HTML Elements and Layout

Client Side Javascript Functions

Examples

Example 1: Create a primary button:

Example 2: Create a primary mini button:

Example 3: Create a secondary button:

Example 4: Create a secondary mini button:

Example 5: Create a reset button:

Example 6: Create an image button:

ButtonBase

getFamily

getValueBinding

setValueBinding

getAction

setAction

getActionListener

setActionListener

getAlt

setAlt

isDisabled

setDisabled

isEscape

setEscape

getImageURL

setImageURL

isMini

setMini

isNoTextPadding

setNoTextPadding

getOnBlur

setOnBlur

getOnClick

setOnClick

getOnDblClick

setOnDblClick

getOnFocus

setOnFocus

getOnKeyDown

setOnKeyDown

getOnKeyPress

setOnKeyPress

getOnKeyUp

setOnKeyUp

getOnMouseDown

setOnMouseDown

getOnMouseMove

setOnMouseMove

getOnMouseOut

setOnMouseOut

getOnMouseOver

setOnMouseOver

getOnMouseUp

setOnMouseUp

isPrimary

setPrimary

isReset

setReset

getStyle

setStyle

getStyleClass

setStyleClass

getTabIndex

setTabIndex

getText

setText

getToolTip

setToolTip

isVisible

setVisible

restoreState

saveState

com.sun.rave.web.ui.component
Class ButtonBase