org.apache.myfaces.trinidad.component.core.nav
Class CoreCommandLink

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCommand
                  extended by org.apache.myfaces.trinidad.component.core.nav.CoreCommandLink
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, DialogSource

public class CoreCommandLink
extends UIXCommand

The commandLink control creates a link representation of a UIXCommand.

Events:

Type Phases Description
javax.faces.event.ActionEvent 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 Apply Request Values Event delivered to prompt the command to launch a dialog.
org.apache.myfaces.trinidad.event.AttributeChangeEvent 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_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
  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, 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, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class javax.faces.component.UIComponent
getContainerClientId, invokeOnComponent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final FacesBean.Type TYPE

TEXT_KEY

public static final PropertyKey TEXT_KEY

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

PARTIAL_SUBMIT_KEY

public static final PropertyKey PARTIAL_SUBMIT_KEY

BLOCKING_KEY

public static final PropertyKey BLOCKING_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

ONBLUR_KEY

public static final PropertyKey ONBLUR_KEY

ONFOCUS_KEY

public static final PropertyKey ONFOCUS_KEY

USE_WINDOW_KEY

public static final PropertyKey USE_WINDOW_KEY

WINDOW_HEIGHT_KEY

public static final PropertyKey WINDOW_HEIGHT_KEY

WINDOW_WIDTH_KEY

public static final PropertyKey WINDOW_WIDTH_KEY

COMPONENT_FAMILY

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

COMPONENT_TYPE

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

CoreCommandLink

public CoreCommandLink()
Construct an instance of the CoreCommandLink.


CoreCommandLink

protected CoreCommandLink(java.lang.String rendererType)
Construct an instance of the CoreCommandLink.

Method Detail

getText

public final java.lang.String getText()
Gets the textual label of the link.

Returns:
the new text value

setText

public final void setText(java.lang.String text)
Sets the textual label of the link.

Parameters:
text - the new text value

isDisabled

public final boolean isDisabled()
Gets whether the link should be considered disabled. This attribute only has meaning when links are used in certain container types, such as global headers and tab bars.

Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets whether the link should be considered disabled. This attribute only has meaning when links are used in certain container types, such as global headers and tab bars.

Parameters:
disabled - the new disabled value

getAccessKey

public final char getAccessKey()
Gets Character used to gain quick access to this link. For accessibility reasons, this functionality is not supported in screen reader mode.

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.

Returns:
the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)
Sets Character used to gain quick access to this link. For accessibility reasons, this functionality is not supported in screen reader mode.

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.

Parameters:
accessKey - the new accessKey value

isPartialSubmit

public final boolean isPartialSubmit()
Gets whether the action should be done through a partial page submit or not. Default is false: no partial page submit.

Returns:
the new partialSubmit value

setPartialSubmit

public final void setPartialSubmit(boolean partialSubmit)
Sets whether the action should be done through a partial page submit or not. Default is false: no partial page submit.

Parameters:
partialSubmit - the new partialSubmit value

isBlocking

public final boolean isBlocking()
Gets If set to TRUE the component will start blocking user input when the action is initiated. The blocking will stop when a response is received from the server.

Returns:
the new blocking value

setBlocking

public final void setBlocking(boolean blocking)
Sets If set to TRUE the component will start blocking user input when the action is initiated. The blocking will stop when a response is received from the server.

Parameters:
blocking - the new blocking value

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component.

Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component.

Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component.

Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component.

Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Parameters:
shortDesc - the new shortDesc value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. 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. Identifiers are relative to the source component, and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. 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. Identifiers are relative to the source component, and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Parameters:
partialTriggers - the new partialTriggers value

getOnclick

public final java.lang.String getOnclick()
Gets an onclick Javascript handler.

Returns:
the new onclick value

setOnclick

public final void setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler.

Parameters:
onclick - the new onclick value

getOndblclick

public final java.lang.String getOndblclick()
Gets an ondblclick Javascript handler.

Returns:
the new ondblclick value

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public final java.lang.String getOnmousedown()
Gets an onmousedown Javascript handler.

Returns:
the new onmousedown value

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public final java.lang.String getOnmouseup()
Gets an onmouseup Javascript handler.

Returns:
the new onmouseup value

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public final java.lang.String getOnmouseover()
Gets an onmouseover Javascript handler.

Returns:
the new onmouseover value

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public final java.lang.String getOnmousemove()
Gets an onmousemove Javascript handler.

Returns:
the new onmousemove value

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public final java.lang.String getOnmouseout()
Gets an onmouseout Javascript handler.

Returns:
the new onmouseout value

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public final java.lang.String getOnkeypress()
Gets an onkeypress Javascript handler.

Returns:
the new onkeypress value

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public final java.lang.String getOnkeydown()
Gets an onkeydown Javascript handler.

Returns:
the new onkeydown value

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public final java.lang.String getOnkeyup()
Gets an onkeyup Javascript handler.

Returns:
the new onkeyup value

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler.

Parameters:
onkeyup - the new onkeyup value

getOnblur

public final java.lang.String getOnblur()
Gets the event handler for the component losing the focus.

Returns:
the new onblur value

setOnblur

public final void setOnblur(java.lang.String onblur)
Sets the event handler for the component losing the focus.

Parameters:
onblur - the new onblur value

getOnfocus

public final java.lang.String getOnfocus()
Gets the event handler for the component gaining the focus.

Returns:
the new onfocus value

setOnfocus

public final void setOnfocus(java.lang.String onfocus)
Sets the event handler for the component gaining the focus.

Parameters:
onfocus - the new onfocus value

isUseWindow

public final boolean isUseWindow()
Gets Indicates whether processes launched by this command should be launched in a secondary dialog window.

Returns:
the new useWindow value

setUseWindow

public final void setUseWindow(boolean useWindow)
Sets Indicates whether processes launched by this command should be launched in a secondary dialog window.

Parameters:
useWindow - the new useWindow value

getWindowHeight

public final int getWindowHeight()
Gets Height of the window, if this command is used to launch a window.

Returns:
the new windowHeight value

setWindowHeight

public final void setWindowHeight(int windowHeight)
Sets Height of the window, if this command is used to launch a window.

Parameters:
windowHeight - the new windowHeight value

getWindowWidth

public final int getWindowWidth()
Gets Width of the window, if this command is used to launch a window.

Returns:
the new windowWidth value

setWindowWidth

public final void setWindowWidth(int windowWidth)
Sets Width of the window, if this command is used to launch a window.

Parameters:
windowWidth - the new windowWidth value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXCommand

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXCommand


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.