|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXCommand
oracle.adf.view.rich.component.rich.nav.RichCommandLink
public class RichCommandLink
<html:p> The commandLink component creates a link that, when pressed, will generate an action event on the server. commandLinks are not rendered on printable pages. </html:p>
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 events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ACCESS_KEY_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
BLOCKING_KEY |
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 java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static java.lang.String |
CONTEXT_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISABLED_KEY |
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 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 |
TEXT_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
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 java.lang.String |
WINDOW_EMBED_STYLE_INLINE_DOCUMENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_EMBED_STYLE_KEY |
static java.lang.String |
WINDOW_EMBED_STYLE_WINDOW |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_HEIGHT_KEY |
static java.lang.String |
WINDOW_MODALITY_TYPE_APPLICATION_MODAL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_MODALITY_TYPE_KEY |
static java.lang.String |
WINDOW_MODALITY_TYPE_MODELESS |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WINDOW_WIDTH_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXCommand |
---|
ACTION_EXPRESSION_KEY, ACTION_LISTENER_KEY, IMMEDIATE_KEY, LAUNCH_LISTENER_KEY, RETURN_LISTENER_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
|
RichCommandLink() Construct an instance of the RichCommandLink. |
protected |
RichCommandLink(java.lang.String rendererType) Construct an instance of the RichCommandLink. |
Method Summary | |
---|---|
char |
getAccessKey() Gets a character used to gain quick access to this link. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
javax.faces.component.UIComponent |
getContext() Location for contextual information. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.String |
getFamily() |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getText() Gets the textual label of the link. |
java.util.Set<java.lang.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. |
java.lang.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. |
java.lang.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 |
isBlocking() Gets an attribute which if set to TRUE the component will start blocking user input when the action is initiated. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isDisabled() Gets whether the link should be considered disabled. |
boolean |
isPartialSubmit() Gets whether the action should be done through a partial page submit or not. |
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 link. |
void |
setBlocking(boolean blocking) Sets an attribute which if set to TRUE the component will start blocking user input when the action is initiated. |
void |
setClientAttributes(java.util.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 |
setContext(javax.faces.component.UIComponent contextFacet) Location for contextual information. |
void |
setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setDisabled(boolean disabled) Sets whether the link should be considered disabled. |
void |
setInlineStyle(java.lang.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(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setText(java.lang.String text) Sets the textual label of the link. |
void |
setUnsecure(java.util.Set<java.lang.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(java.lang.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(java.lang.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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCommand |
---|
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 |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String WINDOW_MODALITY_TYPE_APPLICATION_MODAL
public static final java.lang.String WINDOW_MODALITY_TYPE_MODELESS
public static final java.lang.String WINDOW_EMBED_STYLE_WINDOW
public static final java.lang.String WINDOW_EMBED_STYLE_INLINE_DOCUMENT
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey BLOCKING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_SUBMIT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
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 java.lang.String CONTEXT_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichCommandLink()
protected RichCommandLink(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getContext()
public final void setContext(javax.faces.component.UIComponent contextFacet)
public 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 Link instance. If it does not, the user will receive no visual indication of the existence of the accessKey.
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
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 Link instance. If it does not, the user will receive no visual indication of the existence of the accessKey.
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
accessKey
- the new accessKey valuepublic final boolean isBlocking()
public final void setBlocking(boolean blocking)
blocking
- the new blocking valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final boolean isPartialSubmit()
public final void setPartialSubmit(boolean partialSubmit)
partialSubmit
- the new partialSubmit valuepublic final java.lang.String getText()
public final void setText(java.lang.String text)
text
- the new text valuepublic final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.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 java.lang.String getWindowModalityType()
public final void setWindowModalityType(java.lang.String windowModalityType)
windowModalityType
- the new windowModalityType valuepublic final java.lang.String getWindowEmbedStyle()
public final void setWindowEmbedStyle(java.lang.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 java.lang.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
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |