Skip navigation links

oracle.adf.view.rich.component.rich.layout
Class PartialRichPanelTabbed

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXShowOne
oracle.adf.view.rich.component.rich.layout.PartialRichPanelTabbed

All Implemented Interfaces:

EventListener, 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

Direct Known Subclasses:

RichPanelTabbed

public abstract class PartialRichPanelTabbed

extends org.apache.myfaces.trinidad.component.UIXShowOne

implements javax.faces.component.behavior.ClientBehaviorHolder

The panelTabbed control can be used to display a group of contents that belongs to a showDetailItem. Tab bar(s) with tabs representing the showDetailItem children are displayed. Selecting a tab, displays the associated showDetailItem. If none of the showDetailItem children are selected, the first showDetailItem that is enabled is selected. Typically you would put one or more showDetailItem components inside of the panelTabbed but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelTabbed as long as these wrappers provide showDetailItem components as a result of their execution.

<section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout if the dimensionsFrom attribute is set to "parent".</html:li> <html:li>This component uses <af:showDetailItem> to organize content into each tab body panel. The <af:showDetailItem> will allow stretching if: <html:ul> <html:li>The panelTabbed has dimensionsFrom="parent"</html:li> <html:li>It contains a single child</html:li> <html:li>It has stretchChildren="first" specified</html:li> <html:li>The child has no width, height, margin, border, and padding</html:li> <html:li>The child must be capable of being stretched</html:li> </html:ul> Examples of components that can be stretched inside of a <af:showDetailItem> include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox></html:li> <html:li><af:panelCollection></html:li> <html:li><af:panelGroupLayout layout="scroll"></html:li> <html:li><af:panelGroupLayout layout="vertical"></html:li> <html:li><af:panelHeader></html:li> <html:li><af:panelSplitter></html:li> <html:li><af:panelStretchLayout></html:li> <html:li><af:panelTabbed></html:li> <html:li><af:region></html:li> <html:li><af:table></html:li> <html:li><af:tree></html:li> <html:li><af:treeTable></html:li> </html:ul> If you try to put a component inside of this component and that child component does not support being stretched, then the component hierarchy is illegal. To make it legal, you need to insert another intermediate component between this component and the child component. This intermediate component must support being stretched and must not stretch its children. An example of such a component that is commonly used for this purpose is <af:panelGroupLayout layout="scroll">. By using a wrapper like this, you create a flowing layout area where nothing will be stretched inside of it. Examples of components that do not support being stretched inside of these panelStretchLayout facets (and therefore need to be wrapped) include: <html:ul> <html:li><af:panelBorderLayout></html:li> <html:li><af:panelFormLayout></html:li> <html:li><af:panelGroupLayout layout="default"></html:li> <html:li><af:panelGroupLayout layout="horizontal"></html:li> <html:li><af:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </html:li> </html:ul> There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor: <html:ul> <html:li>You can specify dimensionsFrom="disclosedChild" for the panelTabbed to be as tall as the currently-disclosed af:showDetailItem. When using this "disclosedChild" setting, the stretchChildren attribute on af:showDetailItem and any height assignment on the panelTabbed must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>You can also specify dimensionsFrom="parent" to make the panelTabbed get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin (stretchChildren on af:showDetailItem will be honored).</html:li> <html:li>Using dimensionsFrom="auto" will choose either "disclosedChild" or "parent" depending on whether the panelTabbed is being stretched by its parent.</html:li> </html:ul> </section> <section name="Supports_Compressed_Layout"> <html:p>PanelTabbed supports compressed layout modes of overflow or conveyor belt. Which compressed layout mode is used depends on the assignment of the -tr-layout-type skinning key (see skinning documentation). In order for a compressed layout component to work properly, it must be part of a supported layout on the page.</html:p> <html:p>A compressed layout (overflow or conveyor belt) component requires that it is either:</html:p> <html:ul> <html:li>in a container that stretches its children, or</html:li> <html:li>in a container that has a set width.</html:li> </html:ul> <html:p>Under these circumstances, when the compressed layout component is larger than the parent container, the compressed layout component will display buttons to support its particular compressed layout mode (overflow or conveyor belt).</html:p> <html:p>For overflow compressed layout mode, selecting the overflow button(s) will show a popup containing the items that didn't fit on the page.</html:p> <html:p>For conveyor belt compressed layout mode, selecting the conveyor belt buttons will roll the shown content. In addition, there is a conveyor belt droplist button that shows a popup containing all of the managed items.</html:p> <html:p>Setting up a compressed layout (overflow or conveyor belt) component with the following layouts is not supported. If you use one of these layouts, you may have unexpected and inconsistent results:</html:p> <html:ul> <html:li>in a container that does not stretch its children.</html:li> <html:li>in a container that displays multiple children horizontally without explicit sizes for each child. For example, a panelGroupLayout with layout='horizontal' would be invalid, but panelSplitter is OK because it has an explicitly set splitter position.</html:li> <html:li>setting the compressed layout component with a styleClass or inlineStyle that assigns a percentage width value. Note that this includes assigning styleClass='AFStretchWidth' on a compressed layout component.</html:li> </html:ul> <html:p>At this time overflow and the conveyor belt only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".</html:p> </section>

Events:

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.

Field Summary

static String	CHILD_CREATION_IMMEDIATE
static org.apache.myfaces.trinidad.bean.PropertyKey	CHILD_CREATION_KEY
static String	CHILD_CREATION_LAZY
static String	CHILD_CREATION_LAZY_UNCACHED
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 String	DIMENSIONS_FROM_AUTO
static String	DIMENSIONS_FROM_DISCLOSED_CHILD
static org.apache.myfaces.trinidad.bean.PropertyKey	DIMENSIONS_FROM_KEY
static String	DIMENSIONS_FROM_PARENT
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
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 String	POSITION_ABOVE
static String	POSITION_BELOW
static String	POSITION_BOTH
static String	POSITION_END
static org.apache.myfaces.trinidad.bean.PropertyKey	POSITION_KEY
static String	POSITION_LEFT
static String	POSITION_RIGHT
static String	POSITION_START
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static String	TAB_REMOVAL_ALL
static String	TAB_REMOVAL_ALL_EXCEPT_LAST
static org.apache.myfaces.trinidad.bean.PropertyKey	TAB_REMOVAL_KEY
static String	TAB_REMOVAL_NONE
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

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

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

Method Summary

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()
String	getChildCreation() Gets Controls when the contents of the ShowDetailItem children are created.
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	getDimensionsFrom() Gets
Collection<String>	getEventNames()
String	getFamily()
String	getInlineStyle() Gets the CSS styles to use for this component.
ItemListener[]	getItemListeners() Returns an array of attached item listeners.
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	getPosition() Gets
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
String	getTabRemoval() Gets determines if tab removal is enabled.
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	isVisible() Gets the visibility of the component.
void	removeItemListener(ItemListener listener) Removes a item listener.
void	setChildCreation(String childCreation) Sets Controls when the contents of the ShowDetailItem children are created.
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	setDimensionsFrom(String dimensionsFrom) Sets
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
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	setPosition(String position) Sets
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	setTabRemoval(String tabRemoval) Sets determines if tab removal is enabled.
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.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXShowOne

isChildSelected, queueEvent, visitTree

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, 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

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

CHILD_CREATION_IMMEDIATE

public static final String CHILD_CREATION_IMMEDIATE

See Also:

Constant Field Values

CHILD_CREATION_LAZY

public static final String CHILD_CREATION_LAZY

See Also:

Constant Field Values

CHILD_CREATION_LAZY_UNCACHED

public static final String CHILD_CREATION_LAZY_UNCACHED

See Also:

Constant Field Values

DIMENSIONS_FROM_AUTO

public static final String DIMENSIONS_FROM_AUTO

See Also:

Constant Field Values

DIMENSIONS_FROM_DISCLOSED_CHILD

public static final String DIMENSIONS_FROM_DISCLOSED_CHILD

See Also:

Constant Field Values

DIMENSIONS_FROM_PARENT

public static final String DIMENSIONS_FROM_PARENT

See Also:

Constant Field Values

TRUNCATION_STYLE_NONE

public static final String TRUNCATION_STYLE_NONE

See Also:

Constant Field Values

TRUNCATION_STYLE_ELLIPSIS

public static final String TRUNCATION_STYLE_ELLIPSIS

See Also:

Constant Field Values

POSITION_ABOVE

public static final String POSITION_ABOVE

See Also:

Constant Field Values

POSITION_BOTH

public static final String POSITION_BOTH

See Also:

Constant Field Values

POSITION_BELOW

public static final String POSITION_BELOW

See Also:

Constant Field Values

POSITION_START

public static final String POSITION_START

See Also:

Constant Field Values

POSITION_END

public static final String POSITION_END

See Also:

Constant Field Values

POSITION_LEFT

public static final String POSITION_LEFT

See Also:

Constant Field Values

POSITION_RIGHT

public static final String POSITION_RIGHT

See Also:

Constant Field Values

TAB_REMOVAL_NONE

public static final String TAB_REMOVAL_NONE

See Also:

Constant Field Values

TAB_REMOVAL_ALL

public static final String TAB_REMOVAL_ALL

See Also:

Constant Field Values

TAB_REMOVAL_ALL_EXCEPT_LAST

public static final String TAB_REMOVAL_ALL_EXCEPT_LAST

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

CHILD_CREATION_KEY

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

DIMENSIONS_FROM_KEY

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

MAX_TAB_SIZE_KEY

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

MIN_TAB_SIZE_KEY

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

TRUNCATION_STYLE_KEY

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

POSITION_KEY

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

TAB_REMOVAL_KEY

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

PartialRichPanelTabbed

protected PartialRichPanelTabbed(String rendererType)

Construct an instance of the PartialRichPanelTabbed.

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

getChildCreation

public final String getChildCreation()

Gets Controls when the contents of the ShowDetailItem children are created. Introduces a server-side performance enhancement by postponing construction of the components under the undisclosed ShowDetailItems until they are likely to be disclosed Legal values are:

• "immediate": All showDetailItem children will be populated immediately
• "lazy": ShowDetailItem children will be populated when they are likely to be disclosed and kept in memory thereafter.
• "lazyUncached": ShowDetailItem children will be populated when they are likely to be disclosed and may be removed when undisclosed

Returns:

the new childCreation value

setChildCreation

public final void setChildCreation(String childCreation)

Sets Controls when the contents of the ShowDetailItem children are created. Introduces a server-side performance enhancement by postponing construction of the components under the undisclosed ShowDetailItems until they are likely to be disclosed Legal values are:

• "immediate": All showDetailItem children will be populated immediately
• "lazy": ShowDetailItem children will be populated when they are likely to be disclosed and kept in memory thereafter.
• "lazyUncached": ShowDetailItem children will be populated when they are likely to be disclosed and may be removed when undisclosed

Parameters:

childCreation - the new childCreation value

getDimensionsFrom

public final String getDimensionsFrom()

Gets

determines how the component will handle geometry management. This specifies where the dimensions of the panelTabbed come from:

• auto - either "disclosedChild" or "parent", depending on the container the panelTabbed is inside; if the panelTabbed is being stretched by its ancestor then "parent" will be used, otherwise "disclosedChild" will be used
• disclosedChild - the panelTabbed will get its dimensions from the currently disclosed showDetailItem child (as a result, the stretchChildren attribute on af:showDetailItem and any height assignment on the panelTabbed must be omitted or else it would mean a circular dependency and scrambled display in the browser)
• parent - the panelTabbed will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin (stretchChildren on af:showDetailItem will be honored)

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

Returns:

the new dimensionsFrom value

setDimensionsFrom

public final void setDimensionsFrom(String dimensionsFrom)

Sets

determines how the component will handle geometry management. This specifies where the dimensions of the panelTabbed come from:

• auto - either "disclosedChild" or "parent", depending on the container the panelTabbed is inside; if the panelTabbed is being stretched by its ancestor then "parent" will be used, otherwise "disclosedChild" will be used
• disclosedChild - the panelTabbed will get its dimensions from the currently disclosed showDetailItem child (as a result, the stretchChildren attribute on af:showDetailItem and any height assignment on the panelTabbed must be omitted or else it would mean a circular dependency and scrambled display in the browser)
• parent - the panelTabbed will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin (stretchChildren on af:showDetailItem will be honored)

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

Parameters:

dimensionsFrom - the new dimensionsFrom value

getMaxTabSize

public final String getMaxTabSize()

Gets the maximum tab size that is rendered by default when the tab bar has more than enough space. Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").

Returns:

the new maxTabSize value

setMaxTabSize

public final void setMaxTabSize(String maxTabSize)

Sets the maximum tab size that is rendered by default when the tab bar has more than enough space. Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").

Parameters:

maxTabSize - the new maxTabSize value

getMinTabSize

public final String getMinTabSize()

Gets the minimum tab size that a tab can shrink to before using a compressed layout manager (overflow or conveyor belt). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").

Returns:

the new minTabSize value

setMinTabSize

public final 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). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").

Parameters:

minTabSize - the new minTabSize value

getTruncationStyle

public final String getTruncationStyle()

Gets the truncation style applied to tab text when the text size exceeds the tab size.

Returns:

the new truncationStyle value

setTruncationStyle

public final void setTruncationStyle(String truncationStyle)

Sets the truncation style applied to tab text when the text size exceeds the tab size.

Parameters:

truncationStyle - the new truncationStyle value

getPosition

public final String getPosition()

Gets

the position of the tab bar. Defaults to "above". In accessibility screen reader mode, tab bar position is always "above". When using right/left the position will remain right or left regardless of the language, for example it will remain right or left even in right to left languages like Hebrew and Arabic. Use start/end if the alignment should change depending on the language.

At this time overflow and/or the conveyor belt only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

At this time the tabRemoval attribute only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

Returns:

the new position value

setPosition

public final void setPosition(String position)

Sets

the position of the tab bar. Defaults to "above". In accessibility screen reader mode, tab bar position is always "above". When using right/left the position will remain right or left regardless of the language, for example it will remain right or left even in right to left languages like Hebrew and Arabic. Use start/end if the alignment should change depending on the language.

At this time overflow and/or the conveyor belt only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

At this time the tabRemoval attribute only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

Parameters:

position - the new position value

getTabRemoval

public final String getTabRemoval()

Gets determines if tab removal is enabled.

This attribute supports these tabRemoval types:

• none - tab removal is not enabled.
• all - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed can be removed.
• allExceptLast - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed cannot be removed.

Choosing to remove a tab will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a showDetailItem using the itemListener 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 panelTabbed 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 tab gains focus after a tab is removed.

At this time the tabRemoval attribute only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

Returns:

the new tabRemoval value

setTabRemoval

public final void setTabRemoval(String tabRemoval)

Sets determines if tab removal is enabled.

This attribute supports these tabRemoval types:

• none - tab removal is not enabled.
• all - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed can be removed.
• allExceptLast - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed cannot be removed.

Choosing to remove a tab will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a showDetailItem using the itemListener 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 panelTabbed 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 tab gains focus after a tab is removed.

At this time the tabRemoval attribute only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

Parameters:

tabRemoval - the new tabRemoval 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.UIXShowOne

getBeanType

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

Overrides:

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

Skip navigation links