Summary

Tag Name: <af:panelWindow>
Java Class: oracle.adf.view.rich.component.rich.RichPanelWindow
Component Type: oracle.adf.RichPanelWindow
Required Ancestor Tag(s): af:popup

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.

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.

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.

Geometry Management

  • 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.
  • This component will stretch its children if the following circumstances are met:
    • It contains a single child
    • It has stretchChildren="first" specified
    • The child has no width, height, margin, border, and padding
    • The child must be capable of being stretched
    Examples of components that can be stretched inside of this component include:
    • <af:decorativeBox>
    • <af:panelAccordion>
    • <af:panelBox>
    • <af:panelCollection>
    • <af:panelGroupLayout layout="scroll">
    • <af:panelGroupLayout layout="vertical">
    • <af:panelHeader>
    • <af:panelSplitter>
    • <af:panelStretchLayout>
    • <af:panelTabbed>
    • <af:region>
    • <af:table>
    • <af:tree>
    • <af:treeTable>
    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:
    • <af:panelBorderLayout>
    • <af:panelFormLayout>
    • <af:panelGroupLayout layout="default">
    • <af:panelGroupLayout layout="horizontal">
    • <af:panelLabelAndMessage>
    • <af:panelList>
    • <trh:tableLayout>

Screenshot(s)

panelWindow screenshot
A panelWindow component with closeIconVisible attribute set to true.

Code Example(s)

<af:popup>
  <af:panelWindow closeIconVisible="true" title="Window Header" id="pw1">
    <af:panelGroupLayout id="pgl1">
       <af:outputText id="ot1" value="Some Text or Components"/>
    </af:panelGroupLayout>
  </af:panelWindow>
</af:popup>

Accessibility Guideline(s)

  • helpTopicId attribute: Help information should be provided using the helpTopicId.
    • It is preferred to use helpTopicId instead of shortDesc to provide help information.
  • title attribute: A title must be specified.

Supported Client Events for Client Behaviors

  • click (default)
  • contextMenu
  • dblClick
  • mouseDown
  • mouseMove
  • mouseOut
  • mouseOver
  • mouseUp
  • propertyChange

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.

Attributes

Name Type Supports EL? Description
attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. 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.
binding oracle.adf.view.rich.component.rich.RichPanelWindow Only EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
clientComponent boolean Yes Default Value: false

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.
closeIconVisible boolean Yes Default Value: true

whether the close icon is visible.
contentHeight int Yes the height of the content area of the dialog in pixels.
contentWidth int Yes the width of the content area of the dialog in pixels.
customizationId String Yes This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
helpTopicId String Yes the id used to look up a topic in a helpProvider. If provided, a help icon will appear in the title bar.
id String No the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:
  • They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ).
  • Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyle String Yes 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.
modal boolean Yes Default Value: false

whether the window is modal; by default false.
partialTriggers String[] Yes 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.
rendered boolean Yes Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
resize String Yes Valid Values: off, on
Default Value: off

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.
shortDesc String Yes 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.
stretchChildren String Yes Valid Values: none, first
Default Value: none

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)
styleClass String Yes 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'.
title String Yes the title of the window.
titleIconSource String Yes 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
unsecure java.util.Set Yes 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.
visible boolean Yes Default Value: true

visible has been deprecated. Use the af:showPopupBehavior tag or the show/hide methods on the popup client component.This property has a no-op setter for both the client and server components effectively making it a read-only property.

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.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core