public class RichButton
extends org.apache.myfaces.trinidad.component.UIXCommand
implements javax.faces.component.behavior.ClientBehaviorHolder
Buttons behave differently depending if they have either an action or destination defined. A button with an action, when pressed, will generate an action event on the server. A button with a destination navigates directly to another location instead of delivering an action. If PPRNavigation is enabled, destination URLs specified by a hash, '#', will not work. If both action and destination are defined, then the destination will take precedence.
A button can be contained in a toolbar or placed elsewhere on the page. A button on a toolbar is typically skinned differently than a button not on a toolbar.
Button supports changing the visible attribute through active data.
This component will be excluded when the page is being displayed in emailable and printable modes.
<section name="Geometry_Management"> <html:ul> <html:li>A Button in a toolbar behaves as a toolbar child.</html:li> <html:li>A Button placed elsewhere on the page cannot be stretched by a parent layout component that stretches its children. e.g. panelStretchLayout, panelSplitter.</html:li> <html:li>A Button can have children via a popup facet, but these children appear in a popup that has its own fixed size and is not effected by layout.</html:li> </html:ul> </section>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. |
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ACCESS_KEY_KEY |
static String |
ACTION_DELIVERY_CLIENT_SERVER |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ACTION_DELIVERY_KEY |
static String |
ACTION_DELIVERY_NONE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY
Deprecated.
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
DEPRESSED_ICON_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DESTINATION_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISABLED_ICON_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISABLED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HOVER_ICON_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ICON_KEY |
static String |
ICON_POSITION_BOTTOM |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ICON_POSITION_KEY |
static String |
ICON_POSITION_LEADING |
static String |
ICON_POSITION_TOP |
static String |
ICON_POSITION_TRAILING |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_SUBMIT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static String |
POPUP_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SELECTED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TARGET_FRAME_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TEXT_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static String |
TYPE_CHECK |
static String |
TYPE_DEFAULT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TYPE_KEY |
static String |
TYPE_RADIO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
USE_WINDOW_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
static String |
WINDOW_EMBED_STYLE_INLINE_DOCUMENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_EMBED_STYLE_KEY |
static String |
WINDOW_EMBED_STYLE_WINDOW |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_HEIGHT_KEY |
static String |
WINDOW_MODALITY_TYPE_APPLICATION_MODAL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_MODALITY_TYPE_KEY |
static String |
WINDOW_MODALITY_TYPE_MODELESS |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_WIDTH_KEY |
ACTION_EXPRESSION_KEY, ACTION_LISTENER_KEY, IMMEDIATE_KEY, LAUNCH_LISTENER_KEY, RETURN_LISTENER_KEY
Modifier | Constructor and Description |
---|---|
|
RichButton()
Construct an instance of the RichButton.
|
protected |
RichButton(String rendererType)
Construct an instance of the RichButton.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
char |
getAccessKey()
Gets a character used to gain quick access to this item.
|
String |
getActionDelivery()
Gets how the action events generated by this component should be delivered.
|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
String |
getDepressedIcon()
Gets the URI of an image to be displayed on the button when the mouse button is depressed.
|
String |
getDestination()
Gets the URI this component references when activated.
|
String |
getDisabledIcon()
Gets the URI of an image to be displayed on the button when the button is disabled.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHoverIcon()
Gets the URI of an image to be displayed on the button when the mouse is hovering over the button.
|
String |
getIcon()
Gets the URI of an image to be displayed on the button.
|
String |
getIconPosition()
Gets an attribute specifying the position of the icon.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
javax.faces.component.UIComponent |
getPopup()
The popup displayed by this button from a drop down selector.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getTargetFrame()
Gets the target frame for the navigation.
|
String |
getText()
Gets the text displayed in the button.
|
String |
getType()
Gets the type of button.
|
Set<String> |
getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
String |
getWindowEmbedStyle()
Gets Controls the embedded style of launched window.
|
int |
getWindowHeight()
Gets the height of the window, if this command is used to launch a window.
|
String |
getWindowModalityType()
Gets Controls the modality of the launched Dialog.
|
int |
getWindowWidth()
Gets the width of the window, if this command is used to launch a window.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
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 |
isSelected()
Gets whether the item is selected, for buttons of type radio or check.
|
boolean |
isUseWindow()
Gets whether processes launched by this command should be launched in a secondary browser dialog window.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
setAccessKey(char accessKey)
Sets a character used to gain quick access to this item.
|
void |
setActionDelivery(String actionDelivery)
Sets how the action events generated by this component should be delivered.
|
void |
setClientAttributes(Set clientAttributes)
Sets a set of client attribute names.
|
void |
setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated.
|
void |
setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setDepressedIcon(String depressedIcon)
Sets the URI of an image to be displayed on the button when the mouse button is depressed.
|
void |
setDestination(String destination)
Sets the URI this component references when activated.
|
void |
setDisabled(boolean disabled)
Sets whether the button should be disabled.
|
void |
setDisabledIcon(String disabledIcon)
Sets the URI of an image to be displayed on the button when the button is disabled.
|
void |
setHoverIcon(String hoverIcon)
Sets the URI of an image to be displayed on the button when the mouse is hovering over the button.
|
void |
setIcon(String icon)
Sets the URI of an image to be displayed on the button.
|
void |
setIconPosition(String iconPosition)
Sets an attribute specifying the position of the icon.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
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 |
setPopup(javax.faces.component.UIComponent popupFacet)
The popup displayed by this button from a drop down selector.
|
void |
setSelected(boolean selected)
Sets whether the item is selected, for buttons of type radio or check.
|
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 |
setTargetFrame(String targetFrame)
Sets the target frame for the navigation.
|
void |
setText(String text)
Sets the text displayed in the button.
|
void |
setType(String type)
Sets the type of button.
|
void |
setUnsecure(Set<String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
void |
setUseWindow(boolean useWindow)
Sets whether processes launched by this command should be launched in a secondary browser dialog window.
|
void |
setVisible(boolean visible)
Sets the visibility of the component.
|
void |
setWindowEmbedStyle(String windowEmbedStyle)
Sets Controls the embedded style of launched window.
|
void |
setWindowHeight(int windowHeight)
Sets the height of the window, if this command is used to launch a window.
|
void |
setWindowModalityType(String windowModalityType)
Sets Controls the modality of the launched Dialog.
|
void |
setWindowWidth(int windowWidth)
Sets the 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, 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, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String WINDOW_MODALITY_TYPE_APPLICATION_MODAL
public static final String WINDOW_MODALITY_TYPE_MODELESS
public static final String WINDOW_EMBED_STYLE_WINDOW
public static final String WINDOW_EMBED_STYLE_INLINE_DOCUMENT
public static final String ACTION_DELIVERY_CLIENT_SERVER
public static final String ACTION_DELIVERY_NONE
public static final String ICON_POSITION_LEADING
public static final String ICON_POSITION_TRAILING
public static final String ICON_POSITION_TOP
public static final String ICON_POSITION_BOTTOM
public static final String TYPE_DEFAULT
public static final String TYPE_CHECK
public static final String TYPE_RADIO
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey USE_WINDOW_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_MODALITY_TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_EMBED_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTION_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DEPRESSED_ICON_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DESTINATION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HOVER_ICON_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_ICON_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_POSITION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_SUBMIT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TARGET_FRAME_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY
public static final String POPUP_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichButton()
protected RichButton(String rendererType)
public final javax.faces.component.UIComponent getPopup()
public final void setPopup(javax.faces.component.UIComponent popupFacet)
public 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()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final boolean isUseWindow()
public final void setUseWindow(boolean useWindow)
useWindow
- the new useWindow valuepublic final String getWindowModalityType()
public final void setWindowModalityType(String windowModalityType)
windowModalityType
- the new windowModalityType valuepublic final String getWindowEmbedStyle()
public final void setWindowEmbedStyle(String windowEmbedStyle)
windowEmbedStyle
- the new windowEmbedStyle 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 final char getAccessKey()
If the same access key appears in multiple locations 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 item 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.
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
public final void setAccessKey(char accessKey)
If the same access key appears in multiple locations 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 item 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.
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
accessKey
- the new accessKey valuepublic final String getActionDelivery()
A value of "clientServer" delivers the event normally
public final void setActionDelivery(String actionDelivery)
A value of "clientServer" delivers the event normally
actionDelivery
- the new actionDelivery valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final String getDepressedIcon()
public final void setDepressedIcon(String depressedIcon)
depressedIcon
- the new depressedIcon valuepublic final String getDestination()
If the application allows the destination attribute to be set by end user, ensure 'javascript:' url's are not allowed.
public final void setDestination(String destination)
If the application allows the destination attribute to be set by end user, ensure 'javascript:' url's are not allowed.
destination
- the new destination valuepublic final String getHoverIcon()
public final void setHoverIcon(String hoverIcon)
hoverIcon
- the new hoverIcon valuepublic final String getDisabledIcon()
public final void setDisabledIcon(String disabledIcon)
disabledIcon
- the new disabledIcon valuepublic final String getIcon()
public final void setIcon(String icon)
icon
- the new icon valuepublic final String getIconPosition()
public final void setIconPosition(String iconPosition)
iconPosition
- the new iconPosition valuepublic final boolean isPartialSubmit()
public final void setPartialSubmit(boolean partialSubmit)
partialSubmit
- the new partialSubmit valuepublic final boolean isSelected()
public final void setSelected(boolean selected)
selected
- the new selected valuepublic final String getTargetFrame()
public final void setTargetFrame(String targetFrame)
targetFrame
- the new targetFrame valuepublic final String getText()
public final void setText(String text)
text
- the new text valuepublic final String getType()
A check type button appears in a selected (depressed) state when it is selected. This type is useful to represent a boolean toggle.
A radio type button also appears in a selected (depressed) state when it is selected. Radio type buttons are considered part of the same group by their container, either toolbar or a group within a toolbar. When a radio type button is selected, the other radio type buttons in the same group are unselected. This type is useful to represent a multiple choice toggle. Radio buttons that are part of the same set should be grouped together either in their own group or toolbar container.
public final void setType(String type)
A check type button appears in a selected (depressed) state when it is selected. This type is useful to represent a boolean toggle.
A radio type button also appears in a selected (depressed) state when it is selected. Radio type buttons are considered part of the same group by their container, either toolbar or a group within a toolbar. When a radio type button is selected, the other radio type buttons in the same group are unselected. This type is useful to represent a multiple choice toggle. Radio buttons that are part of the same set should be grouped together either in their own group or toolbar container.
type
- the new type valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXCommand
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXCommand