Skip navigation links

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

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXCommand
oracle.adf.view.rich.component.rich.nav.PartialRichCommandNavigationItem

All Implemented Interfaces:

EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.trinidad.component.DialogSource

Direct Known Subclasses:

RichCommandNavigationItem

public abstract class PartialRichCommandNavigationItem

extends org.apache.myfaces.trinidad.component.UIXCommand

implements javax.faces.component.behavior.ClientBehaviorHolder

<html:p> The commandNavigationItem control creates a navigation item representation of a UIXCommand. 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, but may also be specified explicitly within a navigation component if you're not using a model. This component will be excluded 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> <section name="Item_Events"> <html:p> The af:commandNavigationItem component inside of an af:navigationPane with hint of tabs supports removal of the tabs. When the user removes a tab, an item event is generated with the item type of "removal". On the client, an AdfItemEvent is generated and the method getItemAction() will return a value of AdfItemEvent.ITEM_ACTION_REMOVE on tab removal. Should the client event not be canceled, the event will propagate to the server where a oracle.adf.view.rich.event.ItemEvent will be queued and broadcast. The getType() method may be used to retrieve the event type (removal) on the server. </html:p> </section>

Events:

Type	Phases	Description
oracle.adf.view.rich.event.ItemEvent	Invoke Application Apply Request Values	The itemEvent is triggered when a containing object has an event on one of its child items. For example, a panelTabbed will launch an itemEvent of type 'remove' for one of its child tabs.
javax.faces.event.ActionEvent	Invoke Application Apply Request Values	Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation.
org.apache.myfaces.trinidad.event.ReturnEvent	Apply Request Values	Event delivered when the dialog has completed successfully.
org.apache.myfaces.trinidad.event.LaunchEvent	Invoke Application Apply Request Values	Event delivered to prompt the command to launch a dialog.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change 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 String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DESTINATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ICON_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ITEM_LISTENER_KEY
static String	MESSAGE_TYPE_CONFIRMATION
static String	MESSAGE_TYPE_ERROR
static String	MESSAGE_TYPE_INFO
static org.apache.myfaces.trinidad.bean.PropertyKey	MESSAGE_TYPE_KEY
static String	MESSAGE_TYPE_NONE
static String	MESSAGE_TYPE_WARNING
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_SUBMIT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static String	REMOVE_DISABLED
static String	REMOVE_INHERIT
static org.apache.myfaces.trinidad.bean.PropertyKey	REMOVE_KEY
static String	REMOVE_NO
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_REQUIRED_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	USE_WINDOW_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISITED_KEY
static String	WINDOW_EMBED_STYLE_INLINE_DOCUMENT
static org.apache.myfaces.trinidad.bean.PropertyKey	WINDOW_EMBED_STYLE_KEY
static String	WINDOW_EMBED_STYLE_WINDOW
static org.apache.myfaces.trinidad.bean.PropertyKey	WINDOW_HEIGHT_KEY
static String	WINDOW_MODALITY_TYPE_APPLICATION_MODAL
static org.apache.myfaces.trinidad.bean.PropertyKey	WINDOW_MODALITY_TYPE_KEY
static String	WINDOW_MODALITY_TYPE_MODELESS
static org.apache.myfaces.trinidad.bean.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

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

protected

PartialRichCommandNavigationItem(String rendererType) Construct an instance of the PartialRichCommandNavigationItem.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
void	addItemListener(ItemListener listener) Adds a item listener.
char	getAccessKey() Gets a character used to gain quick access to this item.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
String	getDestination() Gets the URI this component references when activated.
Collection<String>	getEventNames()
String	getFamily()
String	getIcon() Gets the URI of an image to be displayed with the navigation item.
String	getInlineStyle() Gets the CSS styles to use for this component.
javax.el.MethodExpression	getItemListener() Gets a method reference to an item listener
ItemListener[]	getItemListeners() Returns an array of attached item listeners.
String	getMessageType() Gets whether the item needs to be rendered in a manner that indicates an info, confirmation, warning or error exists within its contents.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
String	getRemove() Gets sets the remove ability of the commandNavigationItem.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
String	getTargetFrame() Gets the target frame for the navigation component.
String	getText() Gets the text of the item.
Set<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.
String	getWindowEmbedStyle() Gets Controls the embedded style of launched window.
int	getWindowHeight() Gets the height of the window, if this command is used to launch a window.
String	getWindowModalityType() Gets Controls the modality of the launched Dialog.
int	getWindowWidth() Gets the width of the window, if this command is used to launch a window.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isDisabled() Gets an attribute which if set to TRUE, the component becomes non-interactive.
boolean	isPartialSubmit() Gets whether the action should be done through a partial page submit or not.
boolean	isSelected() Gets whether the item is currently selected.
boolean	isShowRequired() Gets whether the item should show an indicator, indicating that its contents are required.
boolean	isUseWindow() Gets whether processes launched by this command should be launched in a secondary browser dialog window.
boolean	isVisible() Gets the visibility of the component.
boolean	isVisited() Gets whether the item is in visited state.
void	removeItemListener(ItemListener listener) Removes a item listener.
void	setAccessKey(char accessKey) Sets a character used to gain quick access to this item.
void	setClientAttributes(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(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDestination(String destination) Sets the URI this component references when activated.
void	setDisabled(boolean disabled) Sets an attribute which if set to TRUE, the component becomes non-interactive.
void	setIcon(String icon) Sets the URI of an image to be displayed with the navigation item.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setItemListener(javax.el.MethodExpression itemListener) Sets a method reference to an item listener
void	setMessageType(String messageType) Sets whether the item needs to be rendered in a manner that indicates an info, confirmation, warning or error exists within its contents.
void	setPartialSubmit(boolean partialSubmit) Sets whether the action should be done through a partial page submit or not.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setRemove(String remove) Sets sets the remove ability of the commandNavigationItem.
void	setSelected(boolean selected) Sets whether the item is currently selected.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setShowRequired(boolean showRequired) Sets whether the item should show an indicator, indicating that its contents are required.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setTargetFrame(String targetFrame) Sets the target frame for the navigation component.
void	setText(String text) Sets the text of the item.
void	setUnsecure(Set<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	setUseWindow(boolean useWindow) Sets whether processes launched by this command should be launched in a secondary browser dialog window.
void	setVisible(boolean visible) Sets the visibility of the component.
void	setVisited(boolean visited) Sets whether the item is in visited state.
void	setWindowEmbedStyle(String windowEmbedStyle) Sets Controls the embedded style of launched window.
void	setWindowHeight(int windowHeight) Sets the height of the window, if this command is used to launch a window.
void	setWindowModalityType(String windowModalityType) Sets Controls the modality of the launched Dialog.
void	setWindowWidth(int windowWidth) Sets the 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, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, 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, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, 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, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WINDOW_MODALITY_TYPE_APPLICATION_MODAL

public static final String WINDOW_MODALITY_TYPE_APPLICATION_MODAL

See Also:

Constant Field Values

WINDOW_MODALITY_TYPE_MODELESS

public static final String WINDOW_MODALITY_TYPE_MODELESS

See Also:

Constant Field Values

WINDOW_EMBED_STYLE_WINDOW

public static final String WINDOW_EMBED_STYLE_WINDOW

See Also:

Constant Field Values

WINDOW_EMBED_STYLE_INLINE_DOCUMENT

public static final String WINDOW_EMBED_STYLE_INLINE_DOCUMENT

See Also:

Constant Field Values

MESSAGE_TYPE_NONE

public static final String MESSAGE_TYPE_NONE

See Also:

Constant Field Values

MESSAGE_TYPE_INFO

public static final String MESSAGE_TYPE_INFO

See Also:

Constant Field Values

MESSAGE_TYPE_CONFIRMATION

public static final String MESSAGE_TYPE_CONFIRMATION

See Also:

Constant Field Values

MESSAGE_TYPE_WARNING

public static final String MESSAGE_TYPE_WARNING

See Also:

Constant Field Values

MESSAGE_TYPE_ERROR

public static final String MESSAGE_TYPE_ERROR

See Also:

Constant Field Values

REMOVE_INHERIT

public static final String REMOVE_INHERIT

See Also:

Constant Field Values

REMOVE_NO

public static final String REMOVE_NO

See Also:

Constant Field Values

REMOVE_DISABLED

public static final String REMOVE_DISABLED

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

USE_WINDOW_KEY

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

WINDOW_MODALITY_TYPE_KEY

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

WINDOW_EMBED_STYLE_KEY

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

WINDOW_HEIGHT_KEY

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

WINDOW_WIDTH_KEY

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

ACCESS_KEY_KEY

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

DESTINATION_KEY

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

DISABLED_KEY

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

ICON_KEY

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

MESSAGE_TYPE_KEY

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

PARTIAL_SUBMIT_KEY

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

SELECTED_KEY

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

SHOW_REQUIRED_KEY

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

VISITED_KEY

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

ITEM_LISTENER_KEY

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

REMOVE_KEY

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

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PartialRichCommandNavigationItem

protected PartialRichCommandNavigationItem(String rendererType)

Construct an instance of the PartialRichCommandNavigationItem.

Method Detail

getInlineStyle

public final 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(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 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(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 String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<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(Set<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 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(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 Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final 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(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

isUseWindow

public final boolean isUseWindow()

Gets whether processes launched by this command should be launched in a secondary browser dialog window. 'useWindow' requires that the "action" attribute start with "dialog:". Set useWindow to 'false' for the outcome of the action to be targeted to the existing window.

Returns:

the new useWindow value

setUseWindow

public final void setUseWindow(boolean useWindow)

Sets whether processes launched by this command should be launched in a secondary browser dialog window. 'useWindow' requires that the "action" attribute start with "dialog:". Set useWindow to 'false' for the outcome of the action to be targeted to the existing window.

Parameters:

useWindow - the new useWindow value

getWindowModalityType

public final String getWindowModalityType()

Gets Controls the modality of the launched Dialog. The default is modeless.

Returns:

the new windowModalityType value

setWindowModalityType

public final void setWindowModalityType(String windowModalityType)

Sets Controls the modality of the launched Dialog. The default is modeless.

Parameters:

windowModalityType - the new windowModalityType value

getWindowEmbedStyle

public final String getWindowEmbedStyle()

Gets Controls the embedded style of launched window. The "window" option will indicate a new browser window. The "inlineDocument" option will indicate an inline popup window. The default value is "window".

Returns:

the new windowEmbedStyle value

setWindowEmbedStyle

public final void setWindowEmbedStyle(String windowEmbedStyle)

Sets Controls the embedded style of launched window. The "window" option will indicate a new browser window. The "inlineDocument" option will indicate an inline popup window. The default value is "window".

Parameters:

windowEmbedStyle - the new windowEmbedStyle value

getWindowHeight

public final int getWindowHeight()

Gets the 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 the 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 the 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 the width of the window, if this command is used to launch a window.

Parameters:

windowWidth - the new windowWidth 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

getDestination

public final String getDestination()

Gets the URI this component references when activated. This is an alternative to using an action.

Returns:

the new destination value

setDestination

public final void setDestination(String destination)

Sets the URI this component references when activated. This is an alternative to using an action.

Parameters:

destination - the new destination value

isDisabled

public final boolean isDisabled()

Gets an attribute which if set to TRUE, the component becomes non-interactive. Otherwise, the default value is FALSE and the component assumes its expected behavior.

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

Sets an attribute which if set to TRUE, the component becomes non-interactive. Otherwise, the default value is FALSE and the component assumes its expected behavior.

Parameters:

disabled - the new disabled value

getIcon

public final String getIcon()

Gets the URI of an image to be displayed with the navigation item. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"
• relative - a path located relatively to the source page, like "bullet.jpg"
• context relative - a path relatively based on the web application's context root, like "/images/error.png"
• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

Returns:

the new icon value

setIcon

public final void setIcon(String icon)

Sets the URI of an image to be displayed with the navigation item. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"
• relative - a path located relatively to the source page, like "bullet.jpg"
• context relative - a path relatively based on the web application's context root, like "/images/error.png"
• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

Parameters:

icon - the new icon value

getMessageType

public final String getMessageType()

Gets whether the item needs to be rendered in a manner that indicates an info, confirmation, warning or error exists within its contents. This property is currently used only within the train component.

Returns:

the new messageType value

setMessageType

public final void setMessageType(String messageType)

Sets whether the item needs to be rendered in a manner that indicates an info, confirmation, warning or error exists within its contents. This property is currently used only within the train component.

Parameters:

messageType - the new messageType 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; the full page will be refreshed. When set to true, the full page will not be refreshed. To re-render specific components on your page in response to the partial page submit, you have to tell ADF Faces. The easiest way to do this is with the partialTriggers attribute.

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; the full page will be refreshed. When set to true, the full page will not be refreshed. To re-render specific components on your page in response to the partial page submit, you have to tell ADF Faces. The easiest way to do this is with the partialTriggers attribute.

Parameters:

partialSubmit - the new partialSubmit value

isSelected

public final boolean isSelected()

Gets whether the item is currently selected.

Returns:

the new selected value

setSelected

public final void setSelected(boolean selected)

Sets whether the item is currently selected.

Parameters:

selected - the new selected value

isShowRequired

public final boolean isShowRequired()

Gets whether the item should show an indicator, indicating that its contents are required. This property is currently used only within the a train component.

Returns:

the new showRequired value

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether the item should show an indicator, indicating that its contents are required. This property is currently used only within the a train component.

Parameters:

showRequired - the new showRequired value

getTargetFrame

public final String getTargetFrame()

Gets the target frame for the navigation component.

Returns:

the new targetFrame value

setTargetFrame

public final void setTargetFrame(String targetFrame)

Sets the target frame for the navigation component.

Parameters:

targetFrame - the new targetFrame value

getText

public final String getText()

Gets the text of the item.

Returns:

the new text value

setText

public final void setText(String text)

Sets the text of the item.

Parameters:

text - the new text value

isVisited

public final boolean isVisited()

Gets whether the item is in visited state. Depending on the renderer the item may appear in a visited style, if true. This property is currently used only within the a train component.

Returns:

the new visited value

setVisited

public final void setVisited(boolean visited)

Sets whether the item is in visited state. Depending on the renderer the item may appear in a visited style, if true. This property is currently used only within the a train component.

Parameters:

visited - the new visited value

getItemListener

public final javax.el.MethodExpression getItemListener()

Gets a method reference to an item listener

Returns:

the new itemListener value

setItemListener

public final void setItemListener(javax.el.MethodExpression itemListener)

Sets a method reference to an item listener

Parameters:

itemListener - the new itemListener value

getRemove

public final String getRemove()

Gets sets the remove ability of the commandNavigationItem. The default value of "inherit" means that the item inherits its remove ability from its parent container. A value of "no" means that when in a container that supports item removal, this item is not allowed to be removed. A value of "disabled" means that when in a container that supports item removal, this item is not allowed to be removed and it should have a disabled remove indicator. Currently, only a NavigationPane with hint="tabs" supports item removal of child commandNavigationItems.

Returns:

the new remove value

setRemove

public final void setRemove(String remove)

Sets sets the remove ability of the commandNavigationItem. The default value of "inherit" means that the item inherits its remove ability from its parent container. A value of "no" means that when in a container that supports item removal, this item is not allowed to be removed. A value of "disabled" means that when in a container that supports item removal, this item is not allowed to be removed and it should have a disabled remove indicator. Currently, only a NavigationPane with hint="tabs" supports item removal of child commandNavigationItems.

Parameters:

remove - the new remove value

addItemListener

public final void addItemListener(ItemListener listener)

Adds a item listener.

Parameters:

listener - the item listener to add

removeItemListener

public final void removeItemListener(ItemListener listener)

Removes a item listener.

Parameters:

listener - the item listener to remove

getItemListeners

public final ItemListener[] getItemListeners()

Returns an array of attached item listeners.

Returns:

an array of attached item listeners.

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,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(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 String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXCommand

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXCommand

Skip navigation links