|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class RichPanelWindow
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.
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. See af:popup
for more information on cancel dismissal.
<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>
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 events 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 java.lang.String |
COMPONENT_FAMILY |
static java.lang.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 java.lang.String |
RESIZE_OFF |
static java.lang.String |
RESIZE_ON |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static java.lang.String |
STRETCH_CHILDREN_FIRST |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STRETCH_CHILDREN_KEY |
static java.lang.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 |
---|
bindings |
Constructor Summary | |
---|---|
|
RichPanelWindow() Construct an instance of the RichPanelWindow. |
protected |
RichPanelWindow(java.lang.String rendererType) Construct an instance of the RichPanelWindow. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
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. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.String |
getFamily() |
java.lang.String |
getHelpTopicId() Gets the id used to look up a topic in a helpProvider. |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getResize() Gets The dialog's resizing behavior. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStretchChildren() Gets The stretching behavior for children. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getTitle() Gets the title of the window. |
java.lang.String |
getTitleIconSource() Gets the URI specifying the location of the title icon source. |
java.util.Set<java.lang.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(java.util.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(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setHelpTopicId(java.lang.String helpTopicId) Sets the id used to look up a topic in a helpProvider. |
void |
setInlineStyle(java.lang.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(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setResize(java.lang.String resize) Sets The dialog's resizing behavior. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setStretchChildren(java.lang.String stretchChildren) Sets The stretching behavior for children. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setTitle(java.lang.String title) Sets the title of the window. |
void |
setTitleIconSource(java.lang.String titleIconSource) Sets the URI specifying the location of the title icon source. |
void |
setUnsecure(java.util.Set<java.lang.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, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STRETCH_CHILDREN_NONE
public static final java.lang.String STRETCH_CHILDREN_FIRST
public static final java.lang.String RESIZE_OFF
public static final java.lang.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 java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelWindow()
protected RichPanelWindow(java.lang.String rendererType)
Method Detail |
---|
public final boolean isModal()
public final void setModal(boolean modal)
modal
- the new modal valuepublic final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.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 java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String getTitle()
public final void setTitle(java.lang.String title)
title
- the new title valuepublic final java.lang.String getTitleIconSource()
public final void setTitleIconSource(java.lang.String titleIconSource)
titleIconSource
- the new titleIconSource valuepublic final boolean isCloseIconVisible()
public final void setCloseIconVisible(boolean closeIconVisible)
closeIconVisible
- the new closeIconVisible valuepublic final java.lang.String getHelpTopicId()
public final void setHelpTopicId(java.lang.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 java.lang.String getStretchChildren()
public final void setStretchChildren(java.lang.String stretchChildren)
stretchChildren
- the new stretchChildren valuepublic final java.lang.String getResize()
public final void setResize(java.lang.String resize)
resize
- the new resize valuepublic java.lang.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
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |