public class RichNavigationPane
extends org.apache.myfaces.trinidad.component.UIXNavigationLevel
implements javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer
Type | Phases | Description |
---|---|---|
oracle.adf.view.rich.event.ItemEvent |
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. |
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. |
org.apache.myfaces.trinidad.component.UIXCollection.NoColumnFacetsVisitContext
Modifier and Type | Field and Description |
---|---|
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 |
DISABLED_KEY |
static String |
HINT_BAR |
static String |
HINT_BUTTONS |
static String |
HINT_CHOICE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HINT_KEY |
static String |
HINT_LIST |
static String |
HINT_TABS |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static String |
ITEM_REMOVAL_ALL |
static String |
ITEM_REMOVAL_ALL_EXCEPT_LAST |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ITEM_REMOVAL_KEY |
static String |
ITEM_REMOVAL_NONE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAX_TAB_SIZE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MIN_TAB_SIZE_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 |
TITLE_KEY |
static String |
TRUNCATION_STYLE_ELLIPSIS |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TRUNCATION_STYLE_KEY |
static String |
TRUNCATION_STYLE_NONE |
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 |
LEVEL_KEY, NODE_STAMP_FACET, VALUE_KEY, VAR_STATUS_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
RichNavigationPane()
Construct an instance of the RichNavigationPane.
|
protected |
RichNavigationPane(String rendererType)
Construct an instance of the RichNavigationPane.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
void |
addItemListener(ItemListener listener)
Adds a item listener.
|
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() |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHint()
Gets how the navigational items are displayed.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
ItemListener[] |
getItemListeners()
Returns an array of attached item listeners.
|
String |
getItemRemoval()
Gets Determines if item removal is enabled.
|
String |
getMaxTabSize()
Gets the maximum tab size that is rendered by default when the tab bar has more than enough space.
|
String |
getMinTabSize()
Gets the minimum tab size that a tab can shrink to before using a compressed layout manager (overflow or conveyor belt).
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getTitle()
Gets the text that describes the items.
|
String |
getTruncationStyle()
Gets the truncation style applied to tab text when the text size exceeds the tab size.
|
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.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
boolean |
isDisabled()
Gets whether the component is disabled.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
removeItemListener(ItemListener listener)
Removes a item listener.
|
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 |
setDisabled(boolean disabled)
Sets whether the component is disabled.
|
void |
setHint(String hint)
Sets how the navigational items are displayed.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setItemRemoval(String itemRemoval)
Sets Determines if item removal is enabled.
|
void |
setMaxTabSize(String maxTabSize)
Sets the maximum tab size that is rendered by default when the tab bar has more than enough space.
|
void |
setMinTabSize(String minTabSize)
Sets the minimum tab size that a tab can shrink to before using a compressed layout manager (overflow or conveyor belt).
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setShortDesc(String shortDesc)
Sets the short description of the component.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setTitle(String title)
Sets the text that describes the items.
|
void |
setTruncationStyle(String truncationStyle)
Sets the truncation style applied to tab text when the text size exceeds the tab size.
|
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 |
setVisible(boolean visible)
Sets the visibility of the component.
|
getLevel, getNodeStamp, getValue, getVarStatus, processFacetsAndChildren, setLevel, setNodeStamp, setValue, setVarStatus, visitChildren, visitData
createCollectionModel, getFocusRowKey, getMenuModel
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createVarStatusMap, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevel
areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildrenWithoutIterating, visitUnstampedFacets
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, 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, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable, setRowIndex, setRowKey
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable
public static final String HINT_TABS
public static final String HINT_BAR
public static final String HINT_BUTTONS
public static final String HINT_CHOICE
public static final String HINT_LIST
public static final String TRUNCATION_STYLE_NONE
public static final String TRUNCATION_STYLE_ELLIPSIS
public static final String ITEM_REMOVAL_NONE
public static final String ITEM_REMOVAL_ALL
public static final String ITEM_REMOVAL_ALL_EXCEPT_LAST
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HINT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAX_TAB_SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MIN_TAB_SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TRUNCATION_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ITEM_REMOVAL_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichNavigationPane()
protected RichNavigationPane(String rendererType)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
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.
public final void setShortDesc(String shortDesc)
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.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final String getHint()
public final void setHint(String hint)
hint
- the new hint valuepublic final String getMaxTabSize()
public final void setMaxTabSize(String maxTabSize)
maxTabSize
- the new maxTabSize valuepublic final String getMinTabSize()
public final void setMinTabSize(String minTabSize)
minTabSize
- the new minTabSize valuepublic final String getTruncationStyle()
public final void setTruncationStyle(String truncationStyle)
truncationStyle
- the new truncationStyle valuepublic final String getTitle()
public final void setTitle(String title)
title
- the new title valuepublic final String getItemRemoval()
This attribute supports these itemRemoval types:
<html:ul> <html:li> none - item removal is not enabled. This is the default value. </html:li> <html:li> all - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane can be removed.</html:li> <html:li> allExceptLast - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane cannot be removed.</html:li> </html:ul>Choosing to remove an item will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a commandNavigationItem using the itemEventListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the navigationPane component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which item gains focus after an item is removed.
public final void setItemRemoval(String itemRemoval)
This attribute supports these itemRemoval types:
<html:ul> <html:li> none - item removal is not enabled. This is the default value. </html:li> <html:li> all - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane can be removed.</html:li> <html:li> allExceptLast - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane cannot be removed.</html:li> </html:ul>Choosing to remove an item will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a commandNavigationItem using the itemEventListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the navigationPane component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which item gains focus after an item is removed.
itemRemoval
- the new itemRemoval valuepublic final void addItemListener(ItemListener listener)
listener
- the item listener to addpublic final void removeItemListener(ItemListener listener)
listener
- the item listener to removepublic final ItemListener[] getItemListeners()
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXNavigationLevel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXNavigationLevel