Skip navigation links

oracle.adf.view.rich.component.rich
Class RichPanelWindow

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.RichPanelWindow

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 RichPanelWindow

extends org.apache.myfaces.trinidad.component.UIXPanel

implements javax.faces.component.behavior.ClientBehaviorHolder

The af:panelWindow type of popup has identical features to the af:dialog except that it does not have the buttonBar facet or button type configurations. The panelWindow control is a layout element that displays its children inside a window. The af:panelWindow must only be used as the immediate child of the af:popup and only a single occurrence is supported.

Using partial submit commands along with the panel window is recommended because by default, a popup will not restore visibility after a full postback. The immediate parent (af:popup) controls this behavior. If the parent popup's autoCancel property is enabled, full submit commands will cause the popup panel window to auto-dismiss. When the autoCancel property is disabled, full submit commands will restore visibility on postback. See the af:popup tag documentation for more information on controlling aspects of auto-dismissal.

Panel windows will not automatically dismiss for command buttons. Additional logic must be added to dismiss the popup. See the af:popup tag documentation for more information on hiding and displaying popups.

Understanding Close Dismissal

Selecting the panelWindow's close icon translates into a popup-canceled event of the owning inline popup component. Server-side listeners can be registered with the parent af:popup component and will be invoked when the panelWindow is dismissed using the close icon or pressing the Esc key. The parent popup component can also be configured to automatically reset input components on cancellation. This feature is managed using the resetEditableValues property. See af:popup for more information on cancel dismissal.

<section name="Printable_Pages"> Inline popups define content in the page that is hidden by default but when shown is layered above the primary document. Inline popups are not print friendly meaning that their content is excluded from printiable pages similar to navigation components. This also applies to uses of the <af:showPrintablePageBehavior> tag within the content of the af:panelWindow. </section> <section name="Layout_Considerations">

The table below lists the combinations of two panelWindow properties that have effects on layout. The first two columns list the property value combinations and the other two columns outline the assumed behaviors for these options besides caveats to look out for.

stretchChildren	resize	Behaviors	Caveats
none	off	Represents the default settings of the inline popup panelWindow. The panelWindows dimensions are determined by the size of its content. No overflow in the content area. This means that the content area of the panelWindow will not be scrollable or have the ability to clip its content.	If the panelWindow is in its default size to content mode and the content is stretching to the size of the panelWindow, this combination results in an invalid layout that is inconsistently rendered across browsers. Use of the contentWidth and contentHeight properties without the resize=on and/or stretchChildren=first can result in an invalid layout. If the content within the panelWindow has larger dimensions than the specified contentWidith and contentHeight, the content will override the panelWindows dimensions. This is due to the content area not having overflow (scrollable content container) when in the default size to content mode. Dimensions can only be specified in pixels using the contentWidth and contentHeight properties. The styleClass should never be use to set the panelWindows width and height.
first	off	Children of the panelWindow are stretched to the size of the parent dialog container. The panelWindow requires fixed dimensions. The default values for the contentWidth and contentHeight properties are 250 pixels if not explicitly provided. The panelWindows content area will clip content that doesn't fit into its fixed dimensions.	Stretch children feature constraints single immediate child. See geometry management section. The overflow of the content area is hidden and will not display internal scrollbars for navigation. This option assumes that the first child being stretched will have its own scrollbars (af:table or af:panelGroupLayout type=scroll). There is no way to resize the panelWindow outside of changing the contentWidth and contentHeight Dimensions can only be specified in pixels using the contentWidth and contentHeight properties. The styleClass should never be use to set the panelWindows width and height.
none	on	The panelWindow requires fixed dimensions. The default values for the contentWidth and contentHeight properties are 250 pixels if not explicitly provided. The panelWindows content area has auto overflow so it will have scrollbars if the content is larger than can fit into the fixed dimensions. The size of the panelWindow can be adjust by mouse move from the resize gripper in the bottom-end corner. The new size will be remembered the next time the panelWindow is open.	The panelWindow doesn't automatically stretch its children but it can be used with layout components such as the af:panelStretchLayout. The overflow of the content area is auto so internal scrollbars can appear. This can result in double alligned scrollbars if the immediate child has built in scrollable areas (af:table or panelGroupLayout type=scroll). Dimensions can only be specified in pixels using the contentWidth and contentHeight properties. The styleClass should never be use to set the panelWindows width and height.
first	on	Children of the panelWindow are stretched to the size of the parent container. The panelWindow requires fixed dimensions. The default values for the contentWidth and contentHeight properties are 250 pixels if not explicitly provided. The panelWindows content area will clip content that doesn't fit into its fixed dimensions. The size of the panelWindow can be adjust by mouse move from the resize gripper in the bottom-end corner. The new size will be remembered the next time the panelWindow is open.	Stretch children feature constraints single immediate child. See geometry management section. The overflow of the content area is hidden and will not display internal scrollbars for navigation. This option assumes that the first child being stretched will have its own scrollbars (af:table or af:panelGroupLayout type=scroll). Dimensions can only be specified in pixels using the contentWidth and contentHeight properties. The styleClass should never be use to set the panelWindows width and height.

</section> <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component and cannot be assigned dimensions via the inlineStyle or styleClass because it displays on its own layer in the page and gets its dimensions from its children's dimensions or from the specified contentWidth and contentHeight dimensions.</html:li> <html:li>This component will stretch its children if the following circumstances are met: <html:ul> <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 this component 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> </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	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLOSE_ICON_VISIBLE_KEY
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MODAL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RESIZE_KEY
static String	RESIZE_OFF
static String	RESIZE_ON
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static String	STRETCH_CHILDREN_FIRST
static org.apache.myfaces.trinidad.bean.PropertyKey	STRETCH_CHILDREN_KEY
static String	STRETCH_CHILDREN_NONE
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_ICON_SOURCE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_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 Deprecated.

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

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

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
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.
int	getContentHeight() Gets the height of the content area of the dialog in pixels.
int	getContentWidth() Gets the width of the content area of the dialog in pixels.
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	getHelpTopicId() Gets the id used to look up a topic in a helpProvider.
String	getInlineStyle() Gets the CSS styles to use for this component.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
String	getResize() Gets The dialog's resizing behavior.
String	getShortDesc() Gets the short description of the component.
String	getStretchChildren() Gets The stretching behavior for children.
String	getStyleClass() Gets a CSS style class to use for this component.
String	getTitle() Gets the title of the window.
String	getTitleIconSource() Gets the URI specifying the location of the title icon source.
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	isCloseIconVisible() Gets whether the close icon is visible.
boolean	isModal() Gets whether the window is modal; by default false.
boolean	isVisible() Deprecated. visible has been deprecated. Use the af:showPopupBehavior tag or the show/hide methods on the popup client component.
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	setCloseIconVisible(boolean closeIconVisible) Sets whether the close icon is visible.
void	setContentHeight(int contentHeight) Sets the height of the content area of the dialog in pixels.
void	setContentWidth(int contentWidth) Sets the width of the content area of the dialog in pixels.
void	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setHelpTopicId(String helpTopicId) Sets the id used to look up a topic in a helpProvider.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setModal(boolean modal) Sets whether the window is modal; by default false.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setResize(String resize) Sets The dialog's resizing behavior.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setStretchChildren(String stretchChildren) Sets The stretching behavior for children.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setTitle(String title) Sets the title of the window.
void	setTitleIconSource(String titleIconSource) Sets the URI specifying the location of the title icon source.
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) Deprecated. visible has been deprecated. Use the af:showPopupBehavior tag or the show/hide methods on the popup client component.

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, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Field Detail

STRETCH_CHILDREN_NONE

public static final String STRETCH_CHILDREN_NONE

See Also:

Constant Field Values

STRETCH_CHILDREN_FIRST

public static final String STRETCH_CHILDREN_FIRST

See Also:

Constant Field Values

RESIZE_OFF

public static final String RESIZE_OFF

See Also:

Constant Field Values

RESIZE_ON

public static final String RESIZE_ON

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

MODAL_KEY

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

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

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

Deprecated.

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

TITLE_KEY

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

TITLE_ICON_SOURCE_KEY

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

CLOSE_ICON_VISIBLE_KEY

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

HELP_TOPIC_ID_KEY

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

CONTENT_HEIGHT_KEY

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

CONTENT_WIDTH_KEY

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

STRETCH_CHILDREN_KEY

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

RESIZE_KEY

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

RichPanelWindow

public RichPanelWindow()

Construct an instance of the RichPanelWindow.

RichPanelWindow

protected RichPanelWindow(String rendererType)

Construct an instance of the RichPanelWindow.

Method Detail

isModal

public final boolean isModal()

Gets whether the window is modal; by default false.

Returns:

the new modal value

setModal

public final void setModal(boolean modal)

Sets whether the window is modal; by default false.

Parameters:

modal - the new modal value

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

@Deprecated
public final boolean isVisible()

Deprecated. visible has been deprecated. Use the af:showPopupBehavior tag or the show/hide methods on the popup client component.

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

@Deprecated
public final void setVisible(boolean visible)

Deprecated. visible has been deprecated. Use the af:showPopupBehavior tag or the show/hide methods on the popup client component.

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

getTitle

public final String getTitle()

Gets the title of the window.

Returns:

the new title value

setTitle

public final void setTitle(String title)

Sets the title of the window.

Parameters:

title - the new title value

getTitleIconSource

public final String getTitleIconSource()

Gets the URI specifying the location of the title icon source. The title icon will typically be displayed in the top left corner of the window

Returns:

the new titleIconSource value

setTitleIconSource

public final void setTitleIconSource(String titleIconSource)

Sets the URI specifying the location of the title icon source. The title icon will typically be displayed in the top left corner of the window

Parameters:

titleIconSource - the new titleIconSource value

isCloseIconVisible

public final boolean isCloseIconVisible()

Gets whether the close icon is visible.

Returns:

the new closeIconVisible value

setCloseIconVisible

public final void setCloseIconVisible(boolean closeIconVisible)

Sets whether the close icon is visible.

Parameters:

closeIconVisible - the new closeIconVisible value

getHelpTopicId

public final String getHelpTopicId()

Gets the id used to look up a topic in a helpProvider. If provided, a help icon will appear in the title bar.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(String helpTopicId)

Sets the id used to look up a topic in a helpProvider. If provided, a help icon will appear in the title bar.

Parameters:

helpTopicId - the new helpTopicId value

getContentHeight

public final int getContentHeight()

Gets the height of the content area of the dialog in pixels.

Returns:

the new contentHeight value

setContentHeight

public final void setContentHeight(int contentHeight)

Sets the height of the content area of the dialog in pixels.

Parameters:

contentHeight - the new contentHeight value

getContentWidth

public final int getContentWidth()

Gets the width of the content area of the dialog in pixels.

Returns:

the new contentWidth value

setContentWidth

public final void setContentWidth(int contentWidth)

Sets the width of the content area of the dialog in pixels.

Parameters:

contentWidth - the new contentWidth value

getStretchChildren

public final String getStretchChildren()

Gets The stretching behavior for children. Acceptable values include:

• "none": does not attempt to stretch any children (the default value and the value you need to use if you have more than a single child; also the value you need to use if the child does not support being stretched)
• "first": stretches the first child (not to be used if you have multiple children as such usage will produce unreliable results; also not to be used if the child does not support being stretched)

Returns:

the new stretchChildren value

setStretchChildren

public final void setStretchChildren(String stretchChildren)

Sets The stretching behavior for children. Acceptable values include:

• "none": does not attempt to stretch any children (the default value and the value you need to use if you have more than a single child; also the value you need to use if the child does not support being stretched)
• "first": stretches the first child (not to be used if you have multiple children as such usage will produce unreliable results; also not to be used if the child does not support being stretched)

Parameters:

stretchChildren - the new stretchChildren value

getResize

public final String getResize()

Gets The dialog's resizing behavior. Acceptable values include:

• "off": the dialog automatically sizes to its content if stretchChildren is "none".
• "on": user can resize the dialog with their mouse by dragging any of the dialog edges.

Returns:

the new resize value

setResize

public final void setResize(String resize)

Sets The dialog's resizing behavior. Acceptable values include:

• "off": the dialog automatically sizes to its content if stretchChildren is "none".
• "on": user can resize the dialog with their mouse by dragging any of the dialog edges.

Parameters:

resize - the new resize 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.UIXPanel

getBeanType

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

Overrides:

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

Skip navigation links