|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXCommand
org.apache.myfaces.trinidad.component.core.nav.CoreCommandLink
public class CoreCommandLink
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 PropertyKey |
ACCESS_KEY_KEY
|
static PropertyKey |
BLOCKING_KEY
|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static PropertyKey |
DISABLED_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
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXCommand |
---|
ACTION_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 |
Constructor Summary | |
---|---|
|
CoreCommandLink()
Construct an instance of the CoreCommandLink. |
protected |
CoreCommandLink(java.lang.String rendererType)
Construct an instance of the CoreCommandLink. |
Method Summary | |
---|---|
char |
getAccessKey()
Gets Character used to gain quick access to this link. |
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getFamily()
|
java.lang.String |
getInlineStyle()
Gets the CSS styles to use for this component. |
java.lang.String |
getOnblur()
Gets the event handler for the component losing the focus. |
java.lang.String |
getOnclick()
Gets an onclick Javascript handler. |
java.lang.String |
getOndblclick()
Gets an ondblclick Javascript handler. |
java.lang.String |
getOnfocus()
Gets the event handler for the component gaining the focus. |
java.lang.String |
getOnkeydown()
Gets an onkeydown Javascript handler. |
java.lang.String |
getOnkeypress()
Gets an onkeypress Javascript handler. |
java.lang.String |
getOnkeyup()
Gets an onkeyup Javascript handler. |
java.lang.String |
getOnmousedown()
Gets an onmousedown Javascript handler. |
java.lang.String |
getOnmousemove()
Gets an onmousemove Javascript handler. |
java.lang.String |
getOnmouseout()
Gets an onmouseout Javascript handler. |
java.lang.String |
getOnmouseover()
Gets an onmouseover Javascript handler. |
java.lang.String |
getOnmouseup()
Gets an onmouseup Javascript handler. |
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. |
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 link should be considered 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 link. |
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 link should be considered disabled. |
void |
setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. |
void |
setOnblur(java.lang.String onblur)
Sets the event handler for the component losing the focus. |
void |
setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler. |
void |
setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler. |
void |
setOnfocus(java.lang.String onfocus)
Sets the event handler for the component gaining the focus. |
void |
setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler. |
void |
setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler. |
void |
setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler. |
void |
setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler. |
void |
setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler. |
void |
setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler. |
void |
setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler. |
void |
setOnmouseup(java.lang.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(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 |
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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCommand |
---|
addActionListener, addLaunchListener, addReturnListener, broadcast, getAction, getActionListener, getActionListeners, getLaunchListener, getLaunchListeners, getReturnListener, getReturnListeners, isImmediate, queueEvent, removeActionListener, removeLaunchListener, removeReturnListener, setAction, setActionListener, setImmediate, setLaunchListener, setReturnListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
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 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 java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public CoreCommandLink()
protected CoreCommandLink(java.lang.String rendererType)
Method Detail |
---|
public final java.lang.String getText()
public final void setText(java.lang.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 Link instance.
If it does not, the user will receive no visual indication of
the existence of the 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.
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 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.lang.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(java.lang.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 java.lang.String getOnclick()
public final void setOnclick(java.lang.String onclick)
onclick
- the new onclick valuepublic final java.lang.String getOndblclick()
public final void setOndblclick(java.lang.String ondblclick)
ondblclick
- the new ondblclick valuepublic final java.lang.String getOnmousedown()
public final void setOnmousedown(java.lang.String onmousedown)
onmousedown
- the new onmousedown valuepublic final java.lang.String getOnmouseup()
public final void setOnmouseup(java.lang.String onmouseup)
onmouseup
- the new onmouseup valuepublic final java.lang.String getOnmouseover()
public final void setOnmouseover(java.lang.String onmouseover)
onmouseover
- the new onmouseover valuepublic final java.lang.String getOnmousemove()
public final void setOnmousemove(java.lang.String onmousemove)
onmousemove
- the new onmousemove valuepublic final java.lang.String getOnmouseout()
public final void setOnmouseout(java.lang.String onmouseout)
onmouseout
- the new onmouseout valuepublic final java.lang.String getOnkeypress()
public final void setOnkeypress(java.lang.String onkeypress)
onkeypress
- the new onkeypress valuepublic final java.lang.String getOnkeydown()
public final void setOnkeydown(java.lang.String onkeydown)
onkeydown
- the new onkeydown valuepublic final java.lang.String getOnkeyup()
public final void setOnkeyup(java.lang.String onkeyup)
onkeyup
- the new onkeyup valuepublic final java.lang.String getOnblur()
public final void setOnblur(java.lang.String onblur)
onblur
- the new onblur valuepublic final java.lang.String getOnfocus()
public final void setOnfocus(java.lang.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 java.lang.String getFamily()
getFamily
in class UIXCommand
protected FacesBean.Type getBeanType()
getBeanType
in class UIXCommand
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |