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.
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.
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 |
|
|
first | off |
|
|
none | on |
|
|
first | on |
|
|
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. |
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static 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.
|
Modifier | Constructor and Description |
---|---|
|
RichPanelWindow()
Construct an instance of the RichPanelWindow.
|
protected |
RichPanelWindow(String rendererType)
Construct an instance of the RichPanelWindow.
|
Modifier and Type | Method and Description |
---|---|
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.
|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, 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
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, 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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String STRETCH_CHILDREN_NONE
public static final String STRETCH_CHILDREN_FIRST
public static final String RESIZE_OFF
public static final String RESIZE_ON
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey MODAL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_ICON_SOURCE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLOSE_ICON_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STRETCH_CHILDREN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey RESIZE_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichPanelWindow()
protected RichPanelWindow(String rendererType)
public final boolean isModal()
public final void setModal(boolean modal)
modal
- the new modal valuepublic final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure value@Deprecated public final boolean isVisible()
@Deprecated public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String getTitle()
public final void setTitle(String title)
title
- the new title valuepublic final String getTitleIconSource()
public final void setTitleIconSource(String titleIconSource)
titleIconSource
- the new titleIconSource valuepublic final boolean isCloseIconVisible()
public final void setCloseIconVisible(boolean closeIconVisible)
closeIconVisible
- the new closeIconVisible valuepublic final String getHelpTopicId()
public final void setHelpTopicId(String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final int getContentHeight()
public final void setContentHeight(int contentHeight)
contentHeight
- the new contentHeight valuepublic final int getContentWidth()
public final void setContentWidth(int contentWidth)
contentWidth
- the new contentWidth valuepublic final String getStretchChildren()
public final void setStretchChildren(String stretchChildren)
stretchChildren
- the new stretchChildren valuepublic final String getResize()
public final void setResize(String resize)
resize
- the new resize valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXPanel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXPanel