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

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.UIXGo
                  extended by org.apache.myfaces.trinidad.component.core.nav.CoreGoButton
All Implemented Interfaces:
javax.faces.component.StateHolder

public class CoreGoButton
extends UIXGo

The goButton creates a push button that navigates directly to another location instead of delivering an action. It can be used in place of commandButton where a server-side action is not needed.

Events:

Type Phases Description
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 java.lang.String COMPONENT_FAMILY
           
static java.lang.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_TRIGGERS_KEY
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static PropertyKey TARGET_FRAME_KEY
           
static PropertyKey TEXT_KEY
           
static FacesBean.Type TYPE
           
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXGo
DESTINATION_KEY
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Constructor Summary
  CoreGoButton()
          Construct an instance of the CoreGoButton.
protected CoreGoButton(java.lang.String rendererType)
          Construct an instance of the CoreGoButton.
 
Method Summary
 char getAccessKey()
          Gets Character used to gain quick access to this component.
protected  FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 java.lang.String getIcon()
          Gets An URL to an image to use for an icon displayed in the button.
 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 getTargetFrame()
          Gets the target frame for the go component.
 java.lang.String getText()
          Gets the textual label of the go component.
 boolean isDisabled()
          Gets whether the go component should be considered disabled.
 void setAccessKey(char accessKey)
          Sets Character used to gain quick access to this component.
 void setDisabled(boolean disabled)
          Sets whether the go component should be considered disabled.
 void setIcon(java.lang.String icon)
          Sets An URL to an image to use for an icon displayed in the button.
 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 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 setTargetFrame(java.lang.String targetFrame)
          Sets the target frame for the go component.
 void setText(java.lang.String text)
          Sets the textual label of the go component.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXGo
getDestination, setDestination
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, 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, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
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

TARGET_FRAME_KEY

public static final PropertyKey TARGET_FRAME_KEY

ICON_KEY

public static final PropertyKey ICON_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

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

CoreGoButton

public CoreGoButton()
Construct an instance of the CoreGoButton.


CoreGoButton

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

Method Detail

getText

public final java.lang.String getText()
Gets the textual label of the go component. Go components will also render children elements (including text nodes), though not all subclasses of the go component will necessarily support children.


setText

public final void setText(java.lang.String text)
Sets the textual label of the go component. Go components will also render children elements (including text nodes), though not all subclasses of the go component will necessarily support children.


isDisabled

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


setDisabled

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


getAccessKey

public final char getAccessKey()
Gets Character used to gain quick access to this component. 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 go component instance. If it does not, the user will receive no visual indication of the existence of the accessKey.


setAccessKey

public final void setAccessKey(char accessKey)
Sets Character used to gain quick access to this component. 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 go component instance. If it does not, the user will receive no visual indication of the existence of the accessKey.


getTargetFrame

public final java.lang.String getTargetFrame()
Gets the target frame for the go component.


setTargetFrame

public final void setTargetFrame(java.lang.String targetFrame)
Sets the target frame for the go component.


getIcon

public final java.lang.String getIcon()
Gets An URL to an image to use for an icon displayed in the button.


setIcon

public final void setIcon(java.lang.String icon)
Sets An URL to an image to use for an icon displayed in the button.


getInlineStyle

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


setInlineStyle

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


getStyleClass

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


setStyleClass

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


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.


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.


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.


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.


getOnclick

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


setOnclick

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


getOndblclick

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


setOndblclick

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


getOnmousedown

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


setOnmousedown

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


getOnmouseup

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


setOnmouseup

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


getOnmouseover

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


setOnmouseover

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


getOnmousemove

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


setOnmousemove

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


getOnmouseout

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


setOnmouseout

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


getOnkeypress

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


setOnkeypress

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


getOnkeydown

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


setOnkeydown

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


getOnkeyup

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


setOnkeyup

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


getOnblur

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


setOnblur

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


getOnfocus

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


setOnfocus

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


getFamily

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

getBeanType

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


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