Skip navigation links

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

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.RichPanelDrawer

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

public class RichPanelDrawer

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

implements javax.faces.component.behavior.ClientBehaviorHolder

The panelDrawer control can be used to display a group of showDetailItems. Drawer "handles", aka tabs, represent the showDetailItem children. Selecting a tab/handle opens the drawer and displays the associated showDetailItem. Whether a drawer is open is controlled by the disclosed attribute on the showDetailItem children. If none of the children are disclosed, the drawer is "closed" and it's normally shown as attached to the side of a container. Typically you would put one or more showDetailItem components inside of the panelDrawer but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelDrawer as long as these wrappers provide showDetailItem components as a result of their execution.

In some cases you must provide a height and width for the drawer. Please read the geometry management section for more info.

PanelDrawer has some limitations. The panelDrawer should not be nested one inside the other. Also, the panelDrawer uses a transparent popup, therefore there may be limitations as to what it can open over as some content may "bleed" through. For example it may not be able to open over pdf's in the page.

<section name="Geometry_Management"> <html:ul> <html:li>The drawer tries to float on the edge of the container without obstructing the content below. In some situations this may not work and you will need to lay out the drawer in a separate column, for example in a gridLayout or in a facet of panelStretchLayout. </html:li> <html:li>If the width and height attribute aren't set then by default the drawer will open to the size of the content. There are some things to keep in mind: <html:ul> <html:li>If the size of the content will change after the drawer is open (for example you toggle a showDetail inside the drawer which exposes new content) the drawer will not resize, in that case you must set the width and height attributes.</html:li> <html:li>Currently there is no conveyor belt/overflow support, so either you must set the height attribute or the height of the content must be tall enough to allow room for all the handles.</html:li> <html:li>If you are trying to stretch content in the drawer you need to set the width and height attributes, see showDetailItem info below.</html:li> </html:ul> </html:li> <html:li>This component uses <af:showDetailItem> to organize content. The <af:showDetailItem> will allow stretching if: <html:ul> <html:li>The panelDrawer has width and height attributes defined.</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:calendar></html:li> <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:panelGridLayout></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> </html:li> </html:ul> </section>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ALIGN_ID_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	HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAXIMUM_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAXIMUM_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
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 String	SHOW_HANDLES_ALWAYS
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_HANDLES_KEY
static String	SHOW_HANDLES_WHEN_OPEN
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	WIDTH_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

	RichPanelDrawer() Construct an instance of the RichPanelDrawer.
protected	RichPanelDrawer(String rendererType) Construct an instance of the RichPanelDrawer.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
String	getAlignId() Gets The id of the component the drawer should align to.
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	getHeight() Gets Specifies a candidate for the height of the drawer: a fixed CSS length, e.g.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getMaximumHeight() Gets Specifies a candidate for the maximum height of the drawer: a fixed CSS length, e.g.
String	getMaximumWidth() Gets Specifies a candidate for the maximum width of the drawer: a fixed CSS length, e.g.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
String	getPosition() Gets the position of the drawer relative to the container it's aligning to.
String	getShortDesc() Gets the short description of the component.
String	getShowHandles() Gets Allows control over whether to show the tab handle(s).
String	getStyleClass() Gets a CSS style class to use for this component.
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	getWidth() Gets Specifies a candidate for the width of the drawer: a fixed CSS length, e.g.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isVisible() Gets the visibility of the component.
void	setAlignId(String alignId) Sets The id of the component the drawer should align to.
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	setHeight(String height) Sets Specifies a candidate for the height of the drawer: a fixed CSS length, e.g.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setMaximumHeight(String maximumHeight) Sets Specifies a candidate for the maximum height of the drawer: a fixed CSS length, e.g.
void	setMaximumWidth(String maximumWidth) Sets Specifies a candidate for the maximum width of the drawer: a fixed CSS length, e.g.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPosition(String position) Sets the position of the drawer relative to the container it's aligning to.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setShowHandles(String showHandles) Sets Allows control over whether to show the tab handle(s).
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
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.
void	setWidth(String width) Sets Specifies a candidate for the width of the drawer: a fixed CSS length, e.g.

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

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

SHOW_HANDLES_ALWAYS

public static final String SHOW_HANDLES_ALWAYS

See Also:

Constant Field Values

SHOW_HANDLES_WHEN_OPEN

public static final String SHOW_HANDLES_WHEN_OPEN

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

ALIGN_ID_KEY

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

WIDTH_KEY

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

MAXIMUM_WIDTH_KEY

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

HEIGHT_KEY

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

MAXIMUM_HEIGHT_KEY

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

POSITION_KEY

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

SHOW_HANDLES_KEY

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

RichPanelDrawer

public RichPanelDrawer()

Construct an instance of the RichPanelDrawer.

RichPanelDrawer

protected RichPanelDrawer(String rendererType)

Construct an instance of the RichPanelDrawer.

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

getAlignId

public final String getAlignId()

Gets The id of the component the drawer should align to. This is necessary because sometimes the drawer cannot be the direct child of the component it is meant to align to, but in general the drawer should be as close a descendent of the align component as possible. If alignId is not set the default is the drawer's parent.

Returns:

the new alignId value

setAlignId

public final void setAlignId(String alignId)

Sets The id of the component the drawer should align to. This is necessary because sometimes the drawer cannot be the direct child of the component it is meant to align to, but in general the drawer should be as close a descendent of the align component as possible. If alignId is not set the default is the drawer's parent.

Parameters:

alignId - the new alignId value

getWidth

public final String getWidth()

Gets Specifies a candidate for the width of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element width.

If you don't set a value, the width will be driven off the content of the drawer

Returns:

the new width value

setWidth

public final void setWidth(String width)

Sets Specifies a candidate for the width of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element width.

If you don't set a value, the width will be driven off the content of the drawer

Parameters:

width - the new width value

getMaximumWidth

public final String getMaximumWidth()

Gets Specifies a candidate for the maximum width of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element width.

If you don't set a value, the maximumWidth will default to 100%.

Returns:

the new maximumWidth value

setMaximumWidth

public final void setMaximumWidth(String maximumWidth)

Sets Specifies a candidate for the maximum width of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element width.

If you don't set a value, the maximumWidth will default to 100%.

Parameters:

maximumWidth - the new maximumWidth value

getHeight

public final String getHeight()

Gets Specifies a candidate for the height of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element height

If you don't set a value, the height will be driven off the content of the drawer

Returns:

the new height value

setHeight

public final void setHeight(String height)

Sets Specifies a candidate for the height of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element height

If you don't set a value, the height will be driven off the content of the drawer

Parameters:

height - the new height value

getMaximumHeight

public final String getMaximumHeight()

Gets Specifies a candidate for the maximum height of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element height.

If you don't set a value, the maximumHeight will default to 100%.

Returns:

the new maximumHeight value

setMaximumHeight

public final void setMaximumHeight(String maximumHeight)

Sets Specifies a candidate for the maximum height of the drawer:

• a fixed CSS length, e.g. "px"
• a "%" length: make the drawer a fraction of the align element height.

If you don't set a value, the maximumHeight will default to 100%.

Parameters:

maximumHeight - the new maximumHeight value

getPosition

public final String getPosition()

Gets the position of the drawer relative to the container it's aligning to. Defaults to "end". 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.

Returns:

the new position value

setPosition

public final void setPosition(String position)

Sets the position of the drawer relative to the container it's aligning to. Defaults to "end". 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.

Parameters:

position - the new position value

getShowHandles

public final String getShowHandles()

Gets Allows control over whether to show the tab handle(s). When the handles attribute is set to "whenOpen" then the handles aren't shown when the drawer is closed, and the app developer must programmatically open the drawer by setting the "disclosed" attribute to "true" on one of the showDetailItems.

Returns:

the new showHandles value

setShowHandles

public final void setShowHandles(String showHandles)

Sets Allows control over whether to show the tab handle(s). When the handles attribute is set to "whenOpen" then the handles aren't shown when the drawer is closed, and the app developer must programmatically open the drawer by setting the "disclosed" attribute to "true" on one of the showDetailItems.

Parameters:

showHandles - the new showHandles value

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