public class CoreCommandButton extends UIXCommand implements javax.faces.component.behavior.ClientBehaviorHolder
Type | Phases | Description |
---|---|---|
javax.faces.event.ActionEvent |
Invoke Application Apply Request Values |
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation. |
org.apache.myfaces.trinidad.event.ReturnEvent |
Apply Request Values |
Event delivered when the dialog has completed successfully. |
org.apache.myfaces.trinidad.event.LaunchEvent |
Invoke Application Apply Request Values |
Event delivered to prompt the command to launch a dialog. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
UIXComponentBase.ComponentSystemEventListenerWrapper
Modifier and Type | Field and Description |
---|---|
static PropertyKey |
ACCESS_KEY_KEY |
static PropertyKey |
BLOCKING_KEY |
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static PropertyKey |
DISABLED_KEY |
static PropertyKey |
ICON_KEY |
static PropertyKey |
INLINE_STYLE_KEY |
static PropertyKey |
ONBLUR_KEY |
static PropertyKey |
ONCLICK_KEY |
static PropertyKey |
ONDBLCLICK_KEY |
static PropertyKey |
ONFOCUS_KEY |
static PropertyKey |
ONKEYDOWN_KEY |
static PropertyKey |
ONKEYPRESS_KEY |
static PropertyKey |
ONKEYUP_KEY |
static PropertyKey |
ONMOUSEDOWN_KEY |
static PropertyKey |
ONMOUSEMOVE_KEY |
static PropertyKey |
ONMOUSEOUT_KEY |
static PropertyKey |
ONMOUSEOVER_KEY |
static PropertyKey |
ONMOUSEUP_KEY |
static PropertyKey |
PARTIAL_SUBMIT_KEY |
static PropertyKey |
PARTIAL_TRIGGERS_KEY |
static PropertyKey |
SHORT_DESC_KEY |
static PropertyKey |
STYLE_CLASS_KEY |
static PropertyKey |
TEXT_KEY |
static FacesBean.Type |
TYPE |
static PropertyKey |
USE_WINDOW_KEY |
static PropertyKey |
WINDOW_HEIGHT_KEY |
static PropertyKey |
WINDOW_WIDTH_KEY |
ACTION_EXPRESSION_KEY, ACTION_LISTENER_KEY, IMMEDIATE_KEY, LAUNCH_LISTENER_KEY, RETURN_LISTENER_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
CoreCommandButton()
Construct an instance of the CoreCommandButton.
|
protected |
CoreCommandButton(String rendererType)
Construct an instance of the CoreCommandButton.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
char |
getAccessKey()
Gets
Character used to gain quick access to this button.
|
protected FacesBean.Type |
getBeanType() |
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
String |
getDefaultEventName()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getIcon()
Gets An URL to an image to use for an icon displayed in the button.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getOnblur()
Gets the event handler for the component losing the focus.
|
String |
getOnclick()
Gets an onclick Javascript handler.
|
String |
getOndblclick()
Gets an ondblclick Javascript handler.
|
String |
getOnfocus()
Gets the event handler for the component gaining the focus.
|
String |
getOnkeydown()
Gets an onkeydown Javascript handler.
|
String |
getOnkeypress()
Gets an onkeypress Javascript handler.
|
String |
getOnkeyup()
Gets an onkeyup Javascript handler.
|
String |
getOnmousedown()
Gets an onmousedown Javascript handler.
|
String |
getOnmousemove()
Gets an onmousemove Javascript handler.
|
String |
getOnmouseout()
Gets an onmouseout Javascript handler.
|
String |
getOnmouseover()
Gets an onmouseover Javascript handler.
|
String |
getOnmouseup()
Gets an onmouseup Javascript handler.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets The short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getText()
Gets the textual label of the button.
|
int |
getWindowHeight()
Gets Height of the window, if this command is used to launch a window.
|
int |
getWindowWidth()
Gets Width of the window, if this command is used to launch a window.
|
boolean |
isBlocking()
Gets If set to TRUE the component will start blocking user input when the
action is initiated.
|
boolean |
isDisabled()
Gets whether the button should be disabled.
|
boolean |
isPartialSubmit()
Gets whether the action should be done through a partial page submit
or not.
|
boolean |
isUseWindow()
Gets Indicates whether processes launched by this command should be
launched in a secondary dialog window.
|
void |
setAccessKey(char accessKey)
Sets
Character used to gain quick access to this button.
|
void |
setBlocking(boolean blocking)
Sets If set to TRUE the component will start blocking user input when the
action is initiated.
|
void |
setDisabled(boolean disabled)
Sets whether the button should be disabled.
|
void |
setIcon(String icon)
Sets An URL to an image to use for an icon displayed in the button.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setOnblur(String onblur)
Sets the event handler for the component losing the focus.
|
void |
setOnclick(String onclick)
Sets an onclick Javascript handler.
|
void |
setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.
|
void |
setOnfocus(String onfocus)
Sets the event handler for the component gaining the focus.
|
void |
setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.
|
void |
setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.
|
void |
setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.
|
void |
setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.
|
void |
setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.
|
void |
setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.
|
void |
setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.
|
void |
setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.
|
void |
setPartialSubmit(boolean partialSubmit)
Sets whether the action should be done through a partial page submit
or not.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setShortDesc(String shortDesc)
Sets The short description of the component.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setText(String text)
Sets the textual label of the button.
|
void |
setUseWindow(boolean useWindow)
Sets Indicates whether processes launched by this command should be
launched in a secondary dialog window.
|
void |
setWindowHeight(int windowHeight)
Sets Height of the window, if this command is used to launch a window.
|
void |
setWindowWidth(int windowWidth)
Sets Width of the window, if this command is used to launch a window.
|
addActionListener, addLaunchListener, addReturnListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getLaunchListener, getLaunchListeners, getReturnListener, getReturnListeners, isImmediate, queueEvent, removeActionListener, removeLaunchListener, removeReturnListener, setAction, setActionExpression, setActionListener, setImmediate, setLaunchListener, setLaunchListener, setReturnListener, setReturnListener
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final FacesBean.Type TYPE
public static final PropertyKey TEXT_KEY
public static final PropertyKey DISABLED_KEY
public static final PropertyKey ACCESS_KEY_KEY
public static final PropertyKey PARTIAL_SUBMIT_KEY
public static final PropertyKey BLOCKING_KEY
public static final PropertyKey ICON_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final PropertyKey ONBLUR_KEY
public static final PropertyKey ONFOCUS_KEY
public static final PropertyKey USE_WINDOW_KEY
public static final PropertyKey WINDOW_HEIGHT_KEY
public static final PropertyKey WINDOW_WIDTH_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public CoreCommandButton()
protected CoreCommandButton(String rendererType)
public final String getText()
public final void setText(String text)
text
- the new text valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final char getAccessKey()
If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.
This attribute is sometimes referred to as the "mnemonic".
The character specified by this attribute
must exist in the
Text
attribute of this button instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is
to use textAndAccessKey.
public final void setAccessKey(char accessKey)
If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.
This attribute is sometimes referred to as the "mnemonic".
The character specified by this attribute
must exist in the
Text
attribute of this button instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is
to use textAndAccessKey.
accessKey
- the new accessKey valuepublic final boolean isPartialSubmit()
public final void setPartialSubmit(boolean partialSubmit)
partialSubmit
- the new partialSubmit valuepublic final boolean isBlocking()
public final void setBlocking(boolean blocking)
blocking
- the new blocking valuepublic final String getIcon()
public final void setIcon(String icon)
icon
- the new icon valuepublic final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final String[] getPartialTriggers()
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
public final void setPartialTriggers(String[] partialTriggers)
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
partialTriggers
- the new partialTriggers valuepublic final String getOnclick()
public final void setOnclick(String onclick)
onclick
- the new onclick valuepublic final String getOndblclick()
public final void setOndblclick(String ondblclick)
ondblclick
- the new ondblclick valuepublic final String getOnmousedown()
public final void setOnmousedown(String onmousedown)
onmousedown
- the new onmousedown valuepublic final String getOnmouseup()
public final void setOnmouseup(String onmouseup)
onmouseup
- the new onmouseup valuepublic final String getOnmouseover()
public final void setOnmouseover(String onmouseover)
onmouseover
- the new onmouseover valuepublic final String getOnmousemove()
public final void setOnmousemove(String onmousemove)
onmousemove
- the new onmousemove valuepublic final String getOnmouseout()
public final void setOnmouseout(String onmouseout)
onmouseout
- the new onmouseout valuepublic final String getOnkeypress()
public final void setOnkeypress(String onkeypress)
onkeypress
- the new onkeypress valuepublic final String getOnkeydown()
public final void setOnkeydown(String onkeydown)
onkeydown
- the new onkeydown valuepublic final String getOnkeyup()
public final void setOnkeyup(String onkeyup)
onkeyup
- the new onkeyup valuepublic final String getOnblur()
public final void setOnblur(String onblur)
onblur
- the new onblur valuepublic final String getOnfocus()
public final void setOnfocus(String onfocus)
onfocus
- the new onfocus valuepublic final boolean isUseWindow()
public final void setUseWindow(boolean useWindow)
useWindow
- the new useWindow valuepublic final int getWindowHeight()
public final void setWindowHeight(int windowHeight)
windowHeight
- the new windowHeight valuepublic final int getWindowWidth()
public final void setWindowWidth(int windowWidth)
windowWidth
- the new windowWidth valuepublic String getDefaultEventName()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class UIXComponentBase
ClientBehaviorHolder.getDefaultEventName()
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class UIXComponentBase
ClientBehaviorHolder.getClientBehaviors()
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class UIXComponentBase
eventName
- The event namebehavior
- The behavior to addClientBehaviorHolder.addClientBehavior(String, ClientBehavior)
public String getFamily()
getFamily
in class UIXCommand
protected FacesBean.Type getBeanType()
getBeanType
in class UIXCommand
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.