|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
com.sun.rave.web.ui.component.ButtonBase
public abstract class ButtonBase
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.
<ui:button
id="button1" text="#{ButtonBean.text}"
action="#{ButtonBean.success}" />
<ui:button
id="button1" text="#{ButtonBean.text}"
action="#{ButtonBean.success}" mini="true" />
<ui:button
id="button1" text="#{ButtonBean.text}"
action="#{ButtonBean.success}" secondary="true" />
<ui:button
id="button1" text="#{ButtonBean.text}"
action="#{ButtonBean.success}" secondary="true" isMini="true" />
<ui:button
id="button1"
text="#{ButtonBean.text}" action="#{ButtonBean.success}" reset="true"
/>
<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 |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
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 identifier of the component family to which this component belongs. |
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, getActionExpression, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setActionExpression, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ButtonBase()
Construct a new ButtonBase
.
Method Detail |
---|
public java.lang.String getFamily()
Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType
property, may be used to select
the appropriate Renderer
for this component instance.
getFamily
in class javax.faces.component.UICommand
public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)
Return the ValueBinding
stored for the
specified name (if any), respecting any property aliases.
getValueBinding
in class javax.faces.component.UIComponentBase
name
- Name of value binding to retrievepublic 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.
setValueBinding
in class javax.faces.component.UIComponentBase
name
- Name of value binding to setbinding
- ValueBinding to set, or null to removepublic javax.faces.el.MethodBinding getAction()
Method binding representing a method that processes application actions from this component.
getAction
in interface javax.faces.component.ActionSource
getAction
in class javax.faces.component.UICommand
public void setAction(javax.faces.el.MethodBinding action)
Method binding representing a method that processes application actions from this component.
setAction
in interface javax.faces.component.ActionSource
setAction
in class javax.faces.component.UICommand
getAction()
public javax.faces.el.MethodBinding getActionListener()
Method binding representing a method that receives action from this, and possibly other, components.
getActionListener
in interface javax.faces.component.ActionSource
getActionListener
in class javax.faces.component.UICommand
public void setActionListener(javax.faces.el.MethodBinding actionListener)
Method binding representing a method that receives action from this, and possibly other, components.
setActionListener
in interface javax.faces.component.ActionSource
setActionListener
in class javax.faces.component.UICommand
getActionListener()
public java.lang.String getAlt()
Alternative text description used by screen reader tools
public void setAlt(java.lang.String alt)
Alternative text description used by screen reader tools
getAlt()
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.
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.
isDisabled()
public boolean isEscape()
Escape HTML markup in the button text
public void setEscape(boolean escape)
Escape HTML markup in the button text
isEscape()
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".
public 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. Either the "imageURL" or "text" attributes must be specified. When an imageURL value is given, the button type is set to "image".
getImageURL()
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.
public void setMini(boolean mini)
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.
isMini()
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.
public void setNoTextPadding(boolean noTextPadding)
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.
isNoTextPadding()
public java.lang.String getOnBlur()
Scripting code executed when this element loses focus.
public void setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus.
getOnBlur()
public java.lang.String getOnClick()
Scripting code executed when a mouse click occurs over this component.
public void setOnClick(java.lang.String onClick)
Scripting code executed when a mouse click occurs over this component.
getOnClick()
public java.lang.String getOnDblClick()
Scripting code executed when a mouse double click occurs over this component.
public void setOnDblClick(java.lang.String onDblClick)
Scripting code executed when a mouse double click occurs over this component.
getOnDblClick()
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.
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.
getOnFocus()
public java.lang.String getOnKeyDown()
Scripting code executed when the user presses down on a key while the component has focus.
public void setOnKeyDown(java.lang.String onKeyDown)
Scripting code executed when the user presses down on a key while the component has focus.
getOnKeyDown()
public java.lang.String getOnKeyPress()
Scripting code executed when the user presses and releases a key while the component has focus.
public void setOnKeyPress(java.lang.String onKeyPress)
Scripting code executed when the user presses and releases a key while the component has focus.
getOnKeyPress()
public java.lang.String getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus.
public void setOnKeyUp(java.lang.String onKeyUp)
Scripting code executed when the user releases a key while the component has focus.
getOnKeyUp()
public java.lang.String getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
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.
getOnMouseDown()
public java.lang.String getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component.
public void setOnMouseMove(java.lang.String onMouseMove)
Scripting code executed when the user moves the mouse pointer while over the component.
getOnMouseMove()
public java.lang.String getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component.
public void setOnMouseOut(java.lang.String onMouseOut)
Scripting code executed when a mouse out movement occurs over this component.
getOnMouseOut()
public java.lang.String getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component.
public void setOnMouseOver(java.lang.String onMouseOver)
Scripting code executed when the user moves the mouse pointer into the boundary of this component.
getOnMouseOver()
public java.lang.String getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
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.
getOnMouseUp()
public boolean isPrimary()
Indicates that the button is the most commonly used button within a group.
public void setPrimary(boolean primary)
Indicates that the button is the most commonly used button within a group.
isPrimary()
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.
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.
isReset()
public java.lang.String getStyle()
CSS style(s) to be applied when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied when this component is rendered.
getStyleClass()
public int getTabIndex()
The position of this component in the tabbing order sequence
public void setTabIndex(int tabIndex)
The position of this component in the tabbing order sequence
getTabIndex()
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.
public void setText(java.lang.Object text)
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.
getText()
public java.lang.String getToolTip()
Display the text as a tooltip for this component
public void setToolTip(java.lang.String toolTip)
Display the text as a tooltip for this component
getToolTip()
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.
public void setVisible(boolean visible)
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.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UICommand
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UICommand
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |