oracle.adf.view.faces.component.core.nav
Class CoreGoMenuItem

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXGo
                  oracle.adf.view.faces.component.core.nav.CoreGoMenuItem

All Implemented Interfaces:

StateHolder

public class CoreGoMenuItem

extends UIXGo

The goMenuItem control creates a menu item representation of a UIXGo. The item could be rendered as a link, an option, a button, etc. This component is normally used as a stamp for a component that takes a MenuModel object.

Example:

     
             <af:page var="foo" value="#{menu.menuModel}"
                      title="Title attribute">
               <f:facet name="nodeStamp">
                 <af:goMenuItem text="#{foo.label}" destination="#{foo.destination}"/>
               </f:facet> 
             </af:page>
 
 
 

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	LONG_DESC_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	READ_ONLY_KEY
static PropertyKey	SELECTED_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TARGET_FRAME_KEY
static PropertyKey	TEXT_KEY
static FacesBean.Type	TYPE
static java.lang.String	TYPE_DEFAULT Enumerated value indicating that the item has no special type
static java.lang.String	TYPE_GLOBAL Enumerated value indicating that the item is "global" in nature
static PropertyKey	TYPE_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXGo

DESTINATION_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

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

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 a URI specifying the location of a target image.
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getLongDesc() Gets a long description associated with this go 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 bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getTargetFrame() Gets the target frame for the go component.
java.lang.String	getText() Gets the textual label of the go component.
java.lang.String	getType() Gets Used to indicate that the item should be rendered specially.
boolean	isDisabled() Gets whether the go component should be considered disabled.
boolean	isReadOnly() Gets whether the item should be rendered as readOnly.
boolean	isSelected() Gets whether the go component should be considered selected.
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 a URI specifying the location of a target image.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setLongDesc(java.lang.String longDesc) Sets a long description associated with this go 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	setReadOnly(boolean readOnly) Sets whether the item should be rendered as readOnly.
void	setSelected(boolean selected) Sets whether the go component should be considered selected.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
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.
void	setType(java.lang.String type) Sets Used to indicate that the item should be rendered specially.

Methods inherited from class oracle.adf.view.faces.component.UIXGo

getDestination, setDestination

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, 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, 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_DEFAULT

public static final java.lang.String TYPE_DEFAULT

Enumerated value indicating that the item has no special type

See Also:

Constant Field Values

TYPE_GLOBAL

public static final java.lang.String TYPE_GLOBAL

Enumerated value indicating that the item is "global" in nature

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

ICON_KEY

public static final PropertyKey ICON_KEY

SELECTED_KEY

public static final PropertyKey SELECTED_KEY

READ_ONLY_KEY

public static final PropertyKey READ_ONLY_KEY

TYPE_KEY

public static final PropertyKey TYPE_KEY

TEXT_KEY

public static final PropertyKey TEXT_KEY

LONG_DESC_KEY

public static final PropertyKey LONG_DESC_KEY

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONFOCUS_KEY

public static final PropertyKey ONFOCUS_KEY

ONBLUR_KEY

public static final PropertyKey ONBLUR_KEY

TARGET_FRAME_KEY

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

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

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

CoreGoMenuItem

public CoreGoMenuItem()

Construct an instance of the CoreGoMenuItem.

CoreGoMenuItem

protected CoreGoMenuItem(java.lang.String rendererType)

Construct an instance of the CoreGoMenuItem.

Method Detail

getIcon

public final java.lang.String getIcon()

Gets a URI specifying the location of a target image.

setIcon

public final void setIcon(java.lang.String icon)

Sets a URI specifying the location of a target image.

isSelected

public final boolean isSelected()

Gets whether the go component should be considered selected. This attribute only has meaning when go components are used in certain container types, such as global headers and tab bars.

setSelected

public final void setSelected(boolean selected)

Sets whether the go component should be considered selected. This attribute only has meaning when go components are used in certain container types, such as global headers and tab bars.

isReadOnly

public final boolean isReadOnly()

Gets whether the item should be rendered as readOnly. Depending on the renderer the text may or may not appear when readOnly is true.

setReadOnly

public final void setReadOnly(boolean readOnly)

Sets whether the item should be rendered as readOnly. Depending on the renderer the text may or may not appear when readOnly is true.

getType

public final java.lang.String getType()

Gets Used to indicate that the item should be rendered specially. The acceptable values are "default" and "global".

setType

public final void setType(java.lang.String type)

Sets Used to indicate that the item should be rendered specially. The acceptable values are "default" and "global".

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.

getLongDesc

public final java.lang.String getLongDesc()

Gets a long description associated with this go component. This attribute is only used when the go component is in certain container types, such as the message box.

setLongDesc

public final void setLongDesc(java.lang.String longDesc)

Sets a long description associated with this go component. This attribute is only used when the go component is in certain container types, such as the message box.

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.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. 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 bean. 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.

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.

getOnfocus

public final java.lang.String getOnfocus()

Gets the event handler for the component gaining the focus. This attribute is not supported on the following agent types: pda, phone, voice.

setOnfocus

public final void setOnfocus(java.lang.String onfocus)

Sets the event handler for the component gaining the focus. This attribute is not supported on the following agent types: pda, phone, voice.

getOnblur

public final java.lang.String getOnblur()

Gets the event handler for the component losing the focus. This attribute is not supported on the following agent types: pda, phone, voice.

setOnblur

public final void setOnblur(java.lang.String onblur)

Sets the event handler for the component losing the focus. This attribute is not supported on the following agent types: pda, phone, voice.

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.

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.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXGo

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXGo