org.jboss.seam.ui.component.html
Class HtmlButton

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.jboss.seam.ui.component.UISeamCommandBase
                  extended by org.jboss.seam.ui.component.UIButton
                      extended by org.jboss.seam.ui.component.html.HtmlButton
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class HtmlButton
extends UIButton

Component-Type org.jboss.seam.ui.Button Component-Family org.jboss.seam.ui.Button Renderer-Type org.jboss.seam.ui.ButtonRenderer A link that supports invocation of an action with control over conversation propagation. <i>Does not submit the form.</i>


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
HtmlButton()
          Constructor to init default renderers
 
Method Summary
 java.lang.String getAccesskey()
          This attribute assigns an access key to an element.
 javax.el.MethodExpression getActionExpression()
          actionExpression Getter for actionExpression
 javax.faces.el.MethodBinding getActionListener()
          MethodBinding pointing at method accepting an ActionEvent with return type void Getter for actionListener
 java.lang.String getAlt()
          For a user agents that cannot display images, forms, or applets, this attribute specifies alternate text.
 java.lang.String getConversationName()
          The name of the conversation for natural conversations Getter for conversationName
 java.lang.String getDir()
          Direction indication for text that does not inherit directionality.
 java.lang.String getFamily()
           
 java.lang.String getFragment()
          the fragment identifier to link to.
 java.lang.String getImage()
          image Getter for image
 java.lang.String getLang()
          Code describing the language used in the generated markup for this component Getter for lang
 java.lang.String getOnclick()
          HTML: a script expression; a pointer button is clicked Getter for onclick
 java.lang.String getOndblclick()
          HTML: a script expression; a pointer button is double-clicked Getter for ondblclick
 java.lang.String getOnkeydown()
          HTML: a script expression; a key is pressed down Getter for onkeydown
 java.lang.String getOnkeypress()
          HTML: a script expression; a key is pressed and released Getter for onkeypress
 java.lang.String getOnkeyup()
          HTML: a script expression; a key is released Getter for onkeyup
 java.lang.String getOnmousedown()
          HTML: script expression; a pointer button is pressed down Getter for onmousedown
 java.lang.String getOnmousemove()
          HTML: a script expression; a pointer is moved within Getter for onmousemove
 java.lang.String getOnmouseout()
          HTML: a script expression; a pointer is moved away Getter for onmouseout
 java.lang.String getOnmouseover()
          HTML: a script expression; a pointer is moved onto Getter for onmouseover
 java.lang.String getOnmouseup()
          HTML: script expression; a pointer button is released Getter for onmouseup
 java.lang.String getOutcome()
          ${prop.xmlEncodedDescription} Getter for outcome
 java.lang.String getPageflow()
          a pageflow definition to begin.
 java.lang.String getPropagation()
          determines the conversation propagation style: begin, join, nest, none or end.
 int getSize()
          This attribute tells the user agent the initial width of the control.
 java.lang.String getStyle()
          CSS style(s) is/are to be applied when this component is rendered Getter for style
 java.lang.String getStyleClass()
          Corresponds to the HTML class attribute Getter for styleClass
 java.lang.String getTabindex()
          This attribute specifies the position of the current element in the tabbing order for the current document.
 java.lang.Object getTaskInstance()
          Specify the task to operate on (e.g.
 java.lang.String getTitle()
          Advisory title information about markup elements generated for this component Getter for title
 java.lang.String getType()
          submit|reset|image|button This attribute specifies a type of control to create.
 java.lang.String getView()
          the JSF view id to link to.
 boolean isDisabled()
          When set for a form control, this boolean attribute disables the control for user input Getter for disabled
 boolean isImmediate()
          True means, that the default ActionListener should be executed immediately (i.e.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAccesskey(java.lang.String __accesskey)
          This attribute assigns an access key to an element.
 void setActionExpression(javax.el.MethodExpression __actionExpression)
          actionExpression Setter for actionExpression
 void setActionListener(javax.faces.el.MethodBinding __actionListener)
          MethodBinding pointing at method accepting an ActionEvent with return type void Setter for actionListener
 void setAlt(java.lang.String __alt)
          For a user agents that cannot display images, forms, or applets, this attribute specifies alternate text.
 void setConversationName(java.lang.String __conversationName)
          The name of the conversation for natural conversations Setter for conversationName
 void setDir(java.lang.String __dir)
          Direction indication for text that does not inherit directionality.
 void setDisabled(boolean __disabled)
          When set for a form control, this boolean attribute disables the control for user input Setter for disabled
 void setFragment(java.lang.String __fragment)
          the fragment identifier to link to.
 void setImage(java.lang.String __image)
          image Setter for image
 void setImmediate(boolean __immediate)
          True means, that the default ActionListener should be executed immediately (i.e.
 void setLang(java.lang.String __lang)
          Code describing the language used in the generated markup for this component Setter for lang
 void setOnclick(java.lang.String __onclick)
          HTML: a script expression; a pointer button is clicked Setter for onclick
 void setOndblclick(java.lang.String __ondblclick)
          HTML: a script expression; a pointer button is double-clicked Setter for ondblclick
 void setOnkeydown(java.lang.String __onkeydown)
          HTML: a script expression; a key is pressed down Setter for onkeydown
 void setOnkeypress(java.lang.String __onkeypress)
          HTML: a script expression; a key is pressed and released Setter for onkeypress
 void setOnkeyup(java.lang.String __onkeyup)
          HTML: a script expression; a key is released Setter for onkeyup
 void setOnmousedown(java.lang.String __onmousedown)
          HTML: script expression; a pointer button is pressed down Setter for onmousedown
 void setOnmousemove(java.lang.String __onmousemove)
          HTML: a script expression; a pointer is moved within Setter for onmousemove
 void setOnmouseout(java.lang.String __onmouseout)
          HTML: a script expression; a pointer is moved away Setter for onmouseout
 void setOnmouseover(java.lang.String __onmouseover)
          HTML: a script expression; a pointer is moved onto Setter for onmouseover
 void setOnmouseup(java.lang.String __onmouseup)
          HTML: script expression; a pointer button is released Setter for onmouseup
 void setOutcome(java.lang.String __outcome)
          ${prop.xmlEncodedDescription} Setter for outcome
 void setPageflow(java.lang.String __pageflow)
          a pageflow definition to begin.
 void setPropagation(java.lang.String __propagation)
          determines the conversation propagation style: begin, join, nest, none or end.
 void setSize(int __size)
          This attribute tells the user agent the initial width of the control.
 void setStyle(java.lang.String __style)
          CSS style(s) is/are to be applied when this component is rendered Setter for style
 void setStyleClass(java.lang.String __styleClass)
          Corresponds to the HTML class attribute Setter for styleClass
 void setTabindex(java.lang.String __tabindex)
          This attribute specifies the position of the current element in the tabbing order for the current document.
 void setTaskInstance(java.lang.Object __taskInstance)
          Specify the task to operate on (e.g.
 void setTitle(java.lang.String __title)
          Advisory title information about markup elements generated for this component Setter for title
 void setType(java.lang.String __type)
          submit|reset|image|button This attribute specifies a type of control to create.
 void setView(java.lang.String __view)
          the JSF view id to link to.
 
Methods inherited from class org.jboss.seam.ui.component.UISeamCommandBase
addActionListener, getAction, getActionListeners, getParentUIData, getSelection, getUrl, removeActionListener, setAction
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
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
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

HtmlButton

public HtmlButton()
Constructor to init default renderers

Method Detail

setAccesskey

public void setAccesskey(java.lang.String __accesskey)
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey Setter for accesskey

Parameters:
accesskey - - new value

getAccesskey

public java.lang.String getAccesskey()
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey Getter for accesskey

Returns:
accesskey value from local variable or value bindings

setActionExpression

public void setActionExpression(javax.el.MethodExpression __actionExpression)
actionExpression Setter for actionExpression

Parameters:
actionExpression - - new value

getActionExpression

public javax.el.MethodExpression getActionExpression()
actionExpression Getter for actionExpression

Returns:
actionExpression value from local variable or value bindings

setActionListener

public void setActionListener(javax.faces.el.MethodBinding __actionListener)
MethodBinding pointing at method accepting an ActionEvent with return type void Setter for actionListener

Parameters:
actionListener - - new value

getActionListener

public javax.faces.el.MethodBinding getActionListener()
MethodBinding pointing at method accepting an ActionEvent with return type void Getter for actionListener

Returns:
actionListener value from local variable or value bindings

setAlt

public void setAlt(java.lang.String __alt)
For a user agents that cannot display images, forms, or applets, this attribute specifies alternate text. The language of the alternate text is specified by the lang attribute Setter for alt

Parameters:
alt - - new value

getAlt

public java.lang.String getAlt()
For a user agents that cannot display images, forms, or applets, this attribute specifies alternate text. The language of the alternate text is specified by the lang attribute Getter for alt

Returns:
alt value from local variable or value bindings

setConversationName

public void setConversationName(java.lang.String __conversationName)
The name of the conversation for natural conversations Setter for conversationName

Specified by:
setConversationName in class UISeamCommandBase
Parameters:
conversationName - - new value

getConversationName

public java.lang.String getConversationName()
The name of the conversation for natural conversations Getter for conversationName

Specified by:
getConversationName in class UISeamCommandBase
Returns:
conversationName value from local variable or value bindings

setDir

public void setDir(java.lang.String __dir)
Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left) Setter for dir

Parameters:
dir - - new value

getDir

public java.lang.String getDir()
Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left) Getter for dir

Returns:
dir value from local variable or value bindings

setDisabled

public void setDisabled(boolean __disabled)
When set for a form control, this boolean attribute disables the control for user input Setter for disabled

Specified by:
setDisabled in class UIButton
Parameters:
disabled - - new value

isDisabled

public boolean isDisabled()
When set for a form control, this boolean attribute disables the control for user input Getter for disabled

Specified by:
isDisabled in class UIButton
Returns:
disabled value from local variable or value bindings

setFragment

public void setFragment(java.lang.String __fragment)
the fragment identifier to link to. Setter for fragment

Specified by:
setFragment in class UISeamCommandBase
Parameters:
fragment - - new value

getFragment

public java.lang.String getFragment()
the fragment identifier to link to. Getter for fragment

Specified by:
getFragment in class UISeamCommandBase
Returns:
fragment value from local variable or value bindings

setImage

public void setImage(java.lang.String __image)
image Setter for image

Specified by:
setImage in class UIButton
Parameters:
image - - new value

getImage

public java.lang.String getImage()
image Getter for image

Specified by:
getImage in class UIButton
Returns:
image value from local variable or value bindings

setImmediate

public void setImmediate(boolean __immediate)
True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase Setter for immediate

Parameters:
immediate - - new value

isImmediate

public boolean isImmediate()
True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase Getter for immediate

Returns:
immediate value from local variable or value bindings

setLang

public void setLang(java.lang.String __lang)
Code describing the language used in the generated markup for this component Setter for lang

Parameters:
lang - - new value

getLang

public java.lang.String getLang()
Code describing the language used in the generated markup for this component Getter for lang

Returns:
lang value from local variable or value bindings

setOnclick

public void setOnclick(java.lang.String __onclick)
HTML: a script expression; a pointer button is clicked Setter for onclick

Specified by:
setOnclick in class UIButton
Parameters:
onclick - - new value

getOnclick

public java.lang.String getOnclick()
HTML: a script expression; a pointer button is clicked Getter for onclick

Specified by:
getOnclick in class UIButton
Returns:
onclick value from local variable or value bindings

setOndblclick

public void setOndblclick(java.lang.String __ondblclick)
HTML: a script expression; a pointer button is double-clicked Setter for ondblclick

Parameters:
ondblclick - - new value

getOndblclick

public java.lang.String getOndblclick()
HTML: a script expression; a pointer button is double-clicked Getter for ondblclick

Returns:
ondblclick value from local variable or value bindings

setOnkeydown

public void setOnkeydown(java.lang.String __onkeydown)
HTML: a script expression; a key is pressed down Setter for onkeydown

Parameters:
onkeydown - - new value

getOnkeydown

public java.lang.String getOnkeydown()
HTML: a script expression; a key is pressed down Getter for onkeydown

Returns:
onkeydown value from local variable or value bindings

setOnkeypress

public void setOnkeypress(java.lang.String __onkeypress)
HTML: a script expression; a key is pressed and released Setter for onkeypress

Parameters:
onkeypress - - new value

getOnkeypress

public java.lang.String getOnkeypress()
HTML: a script expression; a key is pressed and released Getter for onkeypress

Returns:
onkeypress value from local variable or value bindings

setOnkeyup

public void setOnkeyup(java.lang.String __onkeyup)
HTML: a script expression; a key is released Setter for onkeyup

Parameters:
onkeyup - - new value

getOnkeyup

public java.lang.String getOnkeyup()
HTML: a script expression; a key is released Getter for onkeyup

Returns:
onkeyup value from local variable or value bindings

setOnmousedown

public void setOnmousedown(java.lang.String __onmousedown)
HTML: script expression; a pointer button is pressed down Setter for onmousedown

Parameters:
onmousedown - - new value

getOnmousedown

public java.lang.String getOnmousedown()
HTML: script expression; a pointer button is pressed down Getter for onmousedown

Returns:
onmousedown value from local variable or value bindings

setOnmousemove

public void setOnmousemove(java.lang.String __onmousemove)
HTML: a script expression; a pointer is moved within Setter for onmousemove

Parameters:
onmousemove - - new value

getOnmousemove

public java.lang.String getOnmousemove()
HTML: a script expression; a pointer is moved within Getter for onmousemove

Returns:
onmousemove value from local variable or value bindings

setOnmouseout

public void setOnmouseout(java.lang.String __onmouseout)
HTML: a script expression; a pointer is moved away Setter for onmouseout

Parameters:
onmouseout - - new value

getOnmouseout

public java.lang.String getOnmouseout()
HTML: a script expression; a pointer is moved away Getter for onmouseout

Returns:
onmouseout value from local variable or value bindings

setOnmouseover

public void setOnmouseover(java.lang.String __onmouseover)
HTML: a script expression; a pointer is moved onto Setter for onmouseover

Parameters:
onmouseover - - new value

getOnmouseover

public java.lang.String getOnmouseover()
HTML: a script expression; a pointer is moved onto Getter for onmouseover

Returns:
onmouseover value from local variable or value bindings

setOnmouseup

public void setOnmouseup(java.lang.String __onmouseup)
HTML: script expression; a pointer button is released Setter for onmouseup

Parameters:
onmouseup - - new value

getOnmouseup

public java.lang.String getOnmouseup()
HTML: script expression; a pointer button is released Getter for onmouseup

Returns:
onmouseup value from local variable or value bindings

setOutcome

public void setOutcome(java.lang.String __outcome)
${prop.xmlEncodedDescription} Setter for outcome

Parameters:
outcome - - new value

getOutcome

public java.lang.String getOutcome()
${prop.xmlEncodedDescription} Getter for outcome

Returns:
outcome value from local variable or value bindings

setPageflow

public void setPageflow(java.lang.String __pageflow)
a pageflow definition to begin. (This is only useful when propagation="begin" or propagation="join".) Setter for pageflow

Specified by:
setPageflow in class UISeamCommandBase
Parameters:
pageflow - - new value

getPageflow

public java.lang.String getPageflow()
a pageflow definition to begin. (This is only useful when propagation="begin" or propagation="join".) Getter for pageflow

Specified by:
getPageflow in class UISeamCommandBase
Returns:
pageflow value from local variable or value bindings

setPropagation

public void setPropagation(java.lang.String __propagation)
determines the conversation propagation style: begin, join, nest, none or end. Setter for propagation

Specified by:
setPropagation in class UISeamCommandBase
Parameters:
propagation - - new value

getPropagation

public java.lang.String getPropagation()
determines the conversation propagation style: begin, join, nest, none or end. Getter for propagation

Specified by:
getPropagation in class UISeamCommandBase
Returns:
propagation value from local variable or value bindings

setSize

public void setSize(int __size)
This attribute tells the user agent the initial width of the control. The width is given in pixels except when type attribute has the value "text" or "password". In that case, its value refers to the (integer) number of characters Setter for size

Parameters:
size - - new value

getSize

public int getSize()
This attribute tells the user agent the initial width of the control. The width is given in pixels except when type attribute has the value "text" or "password". In that case, its value refers to the (integer) number of characters Getter for size

Returns:
size value from local variable or value bindings

setStyle

public void setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style

Specified by:
setStyle in class UIButton
Parameters:
style - - new value

getStyle

public java.lang.String getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style

Specified by:
getStyle in class UIButton
Returns:
style value from local variable or value bindings

setStyleClass

public void setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass

Specified by:
setStyleClass in class UIButton
Parameters:
styleClass - - new value

getStyleClass

public java.lang.String getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass

Specified by:
getStyleClass in class UIButton
Returns:
styleClass value from local variable or value bindings

setTabindex

public void setTabindex(java.lang.String __tabindex)
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros Setter for tabindex

Parameters:
tabindex - - new value

getTabindex

public java.lang.String getTabindex()
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros Getter for tabindex

Returns:
tabindex value from local variable or value bindings

setTaskInstance

public void setTaskInstance(java.lang.Object __taskInstance)
Specify the task to operate on (e.g. for @StartTask) Setter for taskInstance

Parameters:
taskInstance - - new value

getTaskInstance

public java.lang.Object getTaskInstance()
Specify the task to operate on (e.g. for @StartTask) Getter for taskInstance

Returns:
taskInstance value from local variable or value bindings

setTitle

public void setTitle(java.lang.String __title)
Advisory title information about markup elements generated for this component Setter for title

Parameters:
title - - new value

getTitle

public java.lang.String getTitle()
Advisory title information about markup elements generated for this component Getter for title

Returns:
title value from local variable or value bindings

setType

public void setType(java.lang.String __type)
submit|reset|image|button This attribute specifies a type of control to create. The default value for this attribute is "submit" Setter for type

Parameters:
type - - new value

getType

public java.lang.String getType()
submit|reset|image|button This attribute specifies a type of control to create. The default value for this attribute is "submit" Getter for type

Returns:
type value from local variable or value bindings

setView

public void setView(java.lang.String __view)
the JSF view id to link to. Setter for view

Specified by:
setView in class UISeamCommandBase
Parameters:
view - - new value

getView

public java.lang.String getView()
the JSF view id to link to. Getter for view

Specified by:
getView in class UISeamCommandBase
Returns:
view value from local variable or value bindings

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UIOutput

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIOutput

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIOutput


Copyright © 2008. All Rights Reserved.