Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.1.0)
E17488-02


oracle.adf.view.rich.component.rich.nav
Class RichGoImageLink

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 oracle.adf.view.rich.component.rich.nav.RichGoImageLink

All Implemented Interfaces:
java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichGoImageLink
extends org.apache.myfaces.trinidad.component.UIXGo
implements javax.faces.component.behavior.ClientBehaviorHolder

<html:p> The goImageLink component renders a HTML link with an icon support, that navigates directly to another location instead of delivering an action. If PPRNavigation is enabled, destination URLs specified by a hash, '#', will not work. This component will be included when the page is being displayed in emailable and printable modes. </html:p> <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component.</html:li> <html:li>This component does not have support for stretching its children.</html:li> </html:ul> </section>

Events:

Type Phases Description
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.

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_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 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 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 org.apache.myfaces.trinidad.bean.PropertyKey ICON_POSITION_KEY
           
static java.lang.String ICON_POSITION_LEADING
           
static java.lang.String ICON_POSITION_TRAILING
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_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 TARGET_FRAME_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 VISIBLE_KEY
           

 

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

 

Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

 

Constructor Summary
  RichGoImageLink()
          Construct an instance of the RichGoImageLink.
protected RichGoImageLink(java.lang.String rendererType)
          Construct an instance of the RichGoImageLink.

 

Method Summary
 void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 char getAccessKey()
          Gets a character used to gain quick access to this item.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
           
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 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 getDefaultEventName()
           
 java.lang.String getDepressedIcon()
          Gets the URI of an image to be displayed with this link when the mouse has pressed the link.
 java.lang.String getDisabledIcon()
          Gets the URI of an image to be displayed with this link when the link is disabled.
 java.util.Collection<java.lang.String> getEventNames()
           
 java.lang.String getFamily()
           
 java.lang.String getHoverIcon()
          Gets the URI of an image to be displayed with this link when the mouse is hovering over the link.
 java.lang.String getIcon()
          Gets the URI of an image to be displayed with the link.
 java.lang.String getIconPosition()
          Gets an attribute specifying the position of the icon.
 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 getTargetFrame()
          Gets the target frame for the form.
 java.lang.String getText()
          Gets the textual label of the go component.
 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.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isDisabled()
          Gets whether the go component should be considered disabled.
 boolean isVisible()
          Gets the visibility of the component.
 void setAccessKey(char accessKey)
          Sets a character used to gain quick access to this item.
 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 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 setDepressedIcon(java.lang.String depressedIcon)
          Sets the URI of an image to be displayed with this link when the mouse has pressed the link.
 void setDisabled(boolean disabled)
          Sets whether the go component should be considered disabled.
 void setDisabledIcon(java.lang.String disabledIcon)
          Sets the URI of an image to be displayed with this link when the link is disabled.
 void setHoverIcon(java.lang.String hoverIcon)
          Sets the URI of an image to be displayed with this link when the mouse is hovering over the link.
 void setIcon(java.lang.String icon)
          Sets the URI of an image to be displayed with the link.
 void setIconPosition(java.lang.String iconPosition)
          Sets an attribute specifying the position of the icon.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 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 form.
 void setText(java.lang.String text)
          Sets the textual label of the go component.
 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 setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXGo
getDestination, setDestination

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, 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, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, clearCachedClientIds, clearCachedClientIds, 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

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

ICON_POSITION_LEADING

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

ICON_POSITION_TRAILING

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

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
Deprecated. 

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

ACCESS_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY

DISABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY

TARGET_FRAME_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TARGET_FRAME_KEY

TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY

DEPRESSED_ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DEPRESSED_ICON_KEY

DISABLED_ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_ICON_KEY

HOVER_ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HOVER_ICON_KEY

ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY

ICON_POSITION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_POSITION_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

RichGoImageLink

public RichGoImageLink()
Construct an instance of the RichGoImageLink.

RichGoImageLink

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

Method Detail

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
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, in which 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 it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
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, in which 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 it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final 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. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
Returns:
the new unsecure value

setUnsecure

public final 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. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
Parameters:
unsecure - the new unsecure value

isVisible

public final boolean isVisible()
Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Parameters:
visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final 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.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Parameters:
clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes 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 (this 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 of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, 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 (this 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 of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

getAccessKey

public final char getAccessKey()
Gets a character used to gain quick access to this item.

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.

Returns:
the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)
Sets a character used to gain quick access to this item.

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.

Parameters:
accessKey - the new accessKey value

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.
Returns:
the new disabled value

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.
Parameters:
disabled - the new disabled value

getTargetFrame

public final java.lang.String getTargetFrame()
Gets the target frame for the form. Can either specify a user-defined frame name, or use one of the following values:
Returns:
the new targetFrame value

setTargetFrame

public final void setTargetFrame(java.lang.String targetFrame)
Sets the target frame for the form. Can either specify a user-defined frame name, or use one of the following values:
Parameters:
targetFrame - the new targetFrame value

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.
Returns:
the new text value

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.
Parameters:
text - the new text value

getDepressedIcon

public final java.lang.String getDepressedIcon()
Gets the URI of an image to be displayed with this link when the mouse has pressed the link. This attribute supports the same URI types described for the icon attribute.

As depressedIcon does not allow alternative text to be provided for the image, in order to create an accessible product depressedIcon must only be used when its use is purely decorative.
Returns:
the new depressedIcon value

setDepressedIcon

public final void setDepressedIcon(java.lang.String depressedIcon)
Sets the URI of an image to be displayed with this link when the mouse has pressed the link. This attribute supports the same URI types described for the icon attribute.

As depressedIcon does not allow alternative text to be provided for the image, in order to create an accessible product depressedIcon must only be used when its use is purely decorative.
Parameters:
depressedIcon - the new depressedIcon value

getDisabledIcon

public final java.lang.String getDisabledIcon()
Gets the URI of an image to be displayed with this link when the link is disabled. This attribute supports the same URI types described for the icon attribute.

As disabledIcon does not allow alternative text to be provided for the image, in order to create an accessible product disabledIcon must only be used when its use is purely decorative.
Returns:
the new disabledIcon value

setDisabledIcon

public final void setDisabledIcon(java.lang.String disabledIcon)
Sets the URI of an image to be displayed with this link when the link is disabled. This attribute supports the same URI types described for the icon attribute.

As disabledIcon does not allow alternative text to be provided for the image, in order to create an accessible product disabledIcon must only be used when its use is purely decorative.
Parameters:
disabledIcon - the new disabledIcon value

getHoverIcon

public final java.lang.String getHoverIcon()
Gets the URI of an image to be displayed with this link when the mouse is hovering over the link. This attribute supports the same URI types described for the icon attribute.

As hoverIcon does not allow alternative text to be provided for the image, in order to create an accessible product hoverIcon must only be used when its use is purely decorative.
Returns:
the new hoverIcon value

setHoverIcon

public final void setHoverIcon(java.lang.String hoverIcon)
Sets the URI of an image to be displayed with this link when the mouse is hovering over the link. This attribute supports the same URI types described for the icon attribute.

As hoverIcon does not allow alternative text to be provided for the image, in order to create an accessible product hoverIcon must only be used when its use is purely decorative.
Parameters:
hoverIcon - the new hoverIcon value

getIcon

public final java.lang.String getIcon()
Gets the URI of an image to be displayed with the link. This attribute supports these various types of URIs: As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.
Returns:
the new icon value

setIcon

public final void setIcon(java.lang.String icon)
Sets the URI of an image to be displayed with the link. This attribute supports these various types of URIs: As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.
Parameters:
icon - the new icon value

getIconPosition

public final java.lang.String getIconPosition()
Gets an attribute specifying the position of the icon.
Returns:
the new iconPosition value

setIconPosition

public final void setIconPosition(java.lang.String iconPosition)
Sets an attribute specifying the position of the icon.
Parameters:
iconPosition - the new iconPosition value

getDefaultEventName

public java.lang.String getDefaultEventName()
Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public java.util.Collection<java.lang.String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
Specified by:
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXGo

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXGo

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.1.0)
E17488-02


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.