|
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
oracle.adf.view.rich.component.UIXDialog
oracle.adf.view.rich.component.rich.RichDialog
public class RichDialog
The dialog control is a layout element that displays its children inside a dialog window and delivers DialogEvents when the OK, Yes, No and Cancel actions are activated. The af:dialog must be placed inside a af:popup component and has to be the immediate child of the af:popup. To show a dialog use the af:showPopupBehavior tag or programmatically from Javascript, call show()
on the popup client component. A dialog will automatically hide itself when OK, Yes or No buttons are selected provided that there are not any faces messages of severity of error or greater on the page. Selecting the Cancel button or close icon will cancel the popup and raise a popup canceled event.
When using the dialog type
button configurations, action outcomes of type "ok", "yes", "no" and "cancel" can be intercepted on the client with a "dialog" type listener. Only "ok", "yes" and "no" events will be propagated to the server. The ESC key, "cancel" button and close icon queues a client dialog event with a "cancel" outcome. Dialog events with a "cancel" outcome will not be sent to the server. Propagation of dialog events to the server can be blocked, as with any RCF event, by calling cancel()
on the JS event object. Use the af:clientListener with a type of dialog
to listen for a dialog client event.
... ... <f:facet name="metaContainer"> <f:verbatim> <script> function handleValueChange(event) { var page = AdfPage.PAGE; var source = event.getSource(); var popupId = source.getProperty("popupId"); page.setPageProperty("changedClientId", source.getClientId()); page.setPageProperty("oldValue", event.getOldValue()); var popup = page.findComponentByAbsoluteId(popupId); var hints = {}; popup.show(hints); } function handleDialog(event) { if (event.getOutcome() == AdfDialogEvent.OUTCOME_NO) { var page = AdfPage.PAGE; var changedClientId = page.getPageProperty("changedClientId"); var oldValue = page.getPageProperty("oldValue"); var source = page.findComponent(changedClientId); source.setValue(oldValue); } } </script> </f:verbatim> </f:facet> <af:form> <af:panelGroupLayout> <af:selectOneRadio label="Gender"> <af:selectItem label="Male" value="M"/> <af:selectItem label="Female" value="F"/> <af:clientListener method="handleValueChange" type="valueChange"/> <af:clientAttribute name="popupId" value="confirmationDialog"/> </af:selectOneRadio> </af:panelGroupLayout> <af:popup id="confirmationDialog"> <af:dialog title="Confirm Change" type="yesNo"> <f:verbatim><p>Would you like to save the change?</p></f:verbatim> <af:clientListener method="handleDialog" type="dialog"/> </af:dialog> </af:popup> </af:form>
A dialog will hide after processing the dialog event for error free actions. If an error occurs during the server-side processing (specifically, if faces messages of error severity or greater) of the dialog event, then the dialog will not be closed.
... ... <af:form> <af:panelGroupLayout> <af:selectOneRadio label="Gender" binding="#{sharedPopup.genderComponent}" valueChangeListener="#{sharedPopup.handleValueChange}" autoSubmit="true" value="#{sharedPopup.gender}"> <af:selectItem label="Male" value="M"/> <af:selectItem label="Female" value="F"/> </af:selectOneRadio> </af:panelGroupLayout> <af:popup id="confirmationDialog" binding="#{sharedPopup.popup}"> <af:dialog title="Confirm Change" type="yesNo" dialogListener="#{sharedPopup.handleDialog}"> <f:verbatim><p>Would you like to save the change?</p></f:verbatim> </af:dialog> </af:popup> </af:form> ... ... public void handleValueChange(ValueChangeEvent event) { setOldGender((String)event.getOldValue()); RichPopup popup = getPopup(); // popup binding UIComponent source = (UIComponent) event.getSource(); RichPopup.PopupHints hints = new RichPopup.PopupHints(); hints.add(RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID, source) .add(RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID, source) .add(RichPopup.PopupHints.HintTypes.HINT_ALIGN, RichPopup.PopupHints.AlignTypes.ALIGN_AFTER_END); popup.show(popup); } public void handleDialog(DialogEvent event) { if (event.getOutcome().equals(DialogEvent.Outcome.no)) { setGender(getOldGender()); RequestContext.getCurrentInstance().addPartialTarget(genderComponent); } }
When using input components, such as inputText
, pressing the Cancel-button will not reset the values on those controls. If you open a dialog for the second time, the old values will still be there. If you want the values to match with the current values on the server, this can be accomplished by setting contentDelivery
to lazyUncached
on the containing popup
component. The lazyUncached
content delivery type will cause the content of the popup to be re-rendered but does not reset the server-side state of the component.
The dialogs cancel button, Esc key and close icon dismisses the inline popup dialog without saving any changes. However, input components having the autoSubmit property turned on, overrides the dialog's cancel behavior.
The af:dialog component provides a buttonBar
facet that is the container to add additional command components to the dialogs footer. Custom buttons are added after pre-configured buttons. Pre-configured buttons are specified using the type
property. Custom buttons will not queue the associated dialogListener
but requires custom action listeners.
Using partial submit custom buttons 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 dialog 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.
A dialog will not automatically dismiss for custom buttons. Additional logic must be added to dismiss the popup. This task is accomplished by calling on the server-side popup API.
... ... <af:popup > <af:dialog title="Confirm Change" type="none" > <f:verbatim><p>Would you like to save the change?</p></f:verbatim> <f:facet name="buttonBar"> <af:panelGroupLayout layout="horizontal"> <af:commandButton text="Yes" id="yes" actionListener="#{sharedPopup.handleDialog}" partialSubmit="true"/> <af:commandButton text="No" id="no" actionListener="#{sharedPopup.handleDialog}" partialSubmit="true"/> </af:panelGroupLayout> </f:facet> </af:dialog> </af:popup> ... ... public void handleDialog(ActionEvent event) { UIComponent source = (UIComponent)event.getSource(); if (source.getId().equals("no")) { setGender(getOldGender()); RequestContext.getCurrentInstance().addPartialTarget(genderComponent); } RichPopup popup = getPopup(); // popup binding popup.hide(); }
Besides using an actionListener
method expression binding of a command component to dismiss a popup by sending a script fragment to the client, another approach is to create action listeners that do the same. These action listeners can attach in a declarative fashion to command components using the f:actionListener
tag.
... ... <af:commandButton textAndAccessKey="#{viewcontrollerBundle.SAVE_AND_CLOSE}" id="saveACBtn1" shortDesc="#{viewcontrollerBundle.SAVE_AND_CLOSE}" immediate="false" partialSubmit="true" actionListener="#{bindings.Commit.execute}" text="Save and Close"> <f:actionListener type="view.PopupDismissActionListener"/> </af:commandButton> <af:commandButton textAndAccessKey="#{viewcontrollerBundle.CANCEL}" id="cancelBtn1" shortDesc="#{viewcontrollerBundle.CANCEL}" immediate="true" actionListener="#{bindings.Rollback.execute}" text="Cancel" partialSubmit="true"> <f:actionListener type="view.PopupCancelActionListener"/> </af:commandButton> ... ... public class PopupDismissActionListener implements ActionListener { private UIComponent _findPopup(UIComponent component) { if (component == null) return null; if (component instanceof RichPopup) return component; return _findPopup(component.getParent()); } private boolean _hasGlobalErrors(FacesContext context) { Iterator<FacesMessage> mi = context.getMessages(null); while (mi.hasNext()) { FacesMessage fmsg = mi.next(); if (fmsg.getSeverity().equals(FacesMessage.SEVERITY_ERROR) || fmsg.getSeverity().equals(FacesMessage.SEVERITY_FATAL)) { return true; } } return false; } private boolean _hasComponentErrors(FacesContext context, UIComponent component) { String clientId = component.getClientId(context); System.out.println(clientId); Iterator<FacesMessage> mi = context.getMessages(clientId); while (mi.hasNext()) { FacesMessage fmsg = mi.next(); if (fmsg.getSeverity().equals(FacesMessage.SEVERITY_ERROR) || fmsg.getSeverity().equals(FacesMessage.SEVERITY_FATAL)) { return true; } } for (UIComponent child: component.getChildren()) { if (_hasComponentErrors(context, child)) { return true; } } return false; } private boolean _hidePopup(FacesContext context, UIComponent popup) { return !_hasGlobalErrors(context) && !_hasComponentErrors(context, popup); } public void processAction(ActionEvent event) throws AbortProcessingException { FacesContext context = FacesContext.getCurrentInstance(); UIComponent source = (UIComponent) event.getSource(); UIComponent popup = _findPopup(source); if (_hidePopup(context, popup)) { popup.hide(); } else { StringBuilder script = new StringBuilder(); script.append("AdfPage.PAGE.showMessages();"); ExtendedRenderKitService erks = Service.getService(context.getRenderKit(), ExtendedRenderKitService.class); erks.addScript(context, script.toString()); } } } ... ... public class PopupCancelActionListener implements ActionListener { ... ... public void processAction(ActionEvent event) throws AbortProcessingException { FacesContext context = FacesContext.getCurrentInstance(); UIComponent source = (UIComponent) event.getSource(); UIComponent popup = _findPopup(source); popup.cancel(); } }
Another common misunderstanding with inline dialogs is that they do not automatically reset submitted values. If you have created custom dialog buttons and dismiss the dialog with validation errors, the previous submitted errors will be displayed on subsequent showings if the page has not be refreshed. To solve this problem use the af:resetActionListener
. This listener will reset all input components within the form. To reset the input components within the popup only, consider developing a custom action listener.
<af:commandButton id="cancel" text="Cancel" immediate="true"> <f:actionListener type="view.ResetPopupActionListener"/> </af:commandButton> ... ... public class ResetPopupActionListener implements ActionListener { private UIComponent _findPopup(UIComponent component) { if (component == null) return null; if (component instanceof RichPopup) return component; return _findPopup(component.getParent()); } public void processAction(ActionEvent event) throws AbortProcessingException { UIComponent source = (UIComponent) event.getSource(); UIComponent popup = _findPopup(source); _resetChildren(popup); } private void _resetChildren(UIComponent comp) { Iterator<UIComponent> kids = comp.getFacetsAndChildren(); while (kids.hasNext()) { UIComponent kid = kids.next(); if (kid instanceof UIXEditableValue) { ((UIXEditableValue) kid).resetValue(); RequestContext.getCurrentInstance().addPartialTarget(kid); } else if (kid instanceof EditableValueHolder) { _resetEditableValueHolder((EditableValueHolder) kid); RequestContext.getCurrentInstance().addPartialTarget(kid); } else if (kid instanceof UIXCollection) { ((UIXCollection) kid).resetStampState(); RequestContext.getCurrentInstance().addPartialTarget(kid); } _resetChildren(kid); } } private void _resetEditableValueHolder(EditableValueHolder evh) { evh.setValue(null); evh.setSubmittedValue(null); evh.setLocalValueSet(false); evh.setValid(true); } }
Another common misunderstanding with custom cancel dialog buttons is they it will not discard values like the pre-configured cancel button using the dialog's type property. This is because the pre-configured cancel button doesn't send a dialog event to the server so the input values contained within the dialogs content will not be applied. A custom cancel button should have the immediate property set to true or programmatically discard any unwanted state applied to the model.
The dialog's cancel button, Esc key, and close icon all raise a client only dialog event with a "cancel" outcome. A dialogListener
will not be notified when the dialog is dismissed using these two commands. However, these commands translate 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 dialog is dismissed using a closed dialog event outcome. 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 |
---|---|---|
oracle.adf.view.rich.event.DialogEvent |
Invoke Application | The dialog event is delivered when a dialog is triggered. |
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 |
AFFIRMATIVE_TEXT_AND_ACCESS_KEY_KEY |
static java.lang.String |
BUTTON_BAR_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CANCEL_TEXT_AND_ACCESS_KEY_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CANCEL_VISIBLE_KEY Deprecated. |
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 |
NO_TEXT_AND_ACCESS_KEY_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
OK_VISIBLE_KEY Deprecated. |
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 java.lang.String |
TYPE_CANCEL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TYPE_KEY |
static java.lang.String |
TYPE_NONE |
static java.lang.String |
TYPE_OK |
static java.lang.String |
TYPE_OK_CANCEL |
static java.lang.String |
TYPE_YES_NO |
static java.lang.String |
TYPE_YES_NO_CANCEL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY Deprecated. |
Fields inherited from class oracle.adf.view.rich.component.UIXDialog |
---|
DIALOG_LISTENER_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
|
RichDialog() Construct an instance of the RichDialog. |
protected |
RichDialog(java.lang.String rendererType) Construct an instance of the RichDialog. |
Method Summary | |
---|---|
java.lang.String |
getAffirmativeTextAndAccessKey() Gets An attribute that simultaneously sets the textual label of the ok and yes footer buttons as well as the an optional accessKey character used to gain quick access to the button. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
javax.faces.component.UIComponent |
getButtonBar() A panel containing custom buttons. |
java.lang.String |
getCancelTextAndAccessKey() Gets An attribute that simultaneously sets the textual label of the cancel footer button as well as the an optional accessKey character used to gain quick access to the button. |
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 |
getNoTextAndAccessKey() Gets An attribute that simultaneously sets the textual label of the no footer button as well as the an optional accessKey character used to gain quick access to the button. |
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.lang.String |
getType() Gets the buttons in the dialog. |
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 |
isCancelVisible() Deprecated. cancelVisible is deprecated. Use the type attribute. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isCloseIconVisible() Gets whether the close icon is visible. |
boolean |
isModal() Gets if the dialog is modal; by default, true. |
boolean |
isOkVisible() Deprecated. okVisible is deprecated. Use the type attribute. |
boolean |
isVisible() Deprecated. visible has been deprecated. Use the af:showPopupBehavior tag or the show/hide methods on the popup client component. |
void |
setAffirmativeTextAndAccessKey(java.lang.String affirmativeTextAndAccessKey) Sets An attribute that simultaneously sets the textual label of the ok and yes footer buttons as well as the an optional accessKey character used to gain quick access to the button. |
void |
setButtonBar(javax.faces.component.UIComponent buttonBarFacet) A panel containing custom buttons. |
void |
setCancelTextAndAccessKey(java.lang.String cancelTextAndAccessKey) Sets An attribute that simultaneously sets the textual label of the cancel footer button as well as the an optional accessKey character used to gain quick access to the button. |
void |
setCancelVisible(boolean cancelVisible) Deprecated. cancelVisible is deprecated. Use the type attribute. |
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 if the dialog is modal; by default, true. |
void |
setNoTextAndAccessKey(java.lang.String noTextAndAccessKey) Sets An attribute that simultaneously sets the textual label of the no footer button as well as the an optional accessKey character used to gain quick access to the button. |
void |
setOkVisible(boolean okVisible) Deprecated. okVisible is deprecated. Use the type attribute. |
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 |
setType(java.lang.String type) Sets the buttons in the dialog. |
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 oracle.adf.view.rich.component.UIXDialog |
---|
addDialogListener, broadcast, getDialogListener, getDialogListeners, processDismissal, queueEvent, removeDialogListener, setDialogListener, setDialogListener |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, 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, 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 java.lang.String TYPE_NONE
public static final java.lang.String TYPE_OK
public static final java.lang.String TYPE_CANCEL
public static final java.lang.String TYPE_YES_NO
public static final java.lang.String TYPE_OK_CANCEL
public static final java.lang.String TYPE_YES_NO_CANCEL
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
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 org.apache.myfaces.trinidad.bean.PropertyKey AFFIRMATIVE_TEXT_AND_ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CANCEL_TEXT_AND_ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey NO_TEXT_AND_ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MODAL_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey OK_VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CANCEL_VISIBLE_KEY
public static final java.lang.String BUTTON_BAR_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichDialog()
protected RichDialog(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getButtonBar()
public final void setButtonBar(javax.faces.component.UIComponent buttonBarFacet)
public 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 final java.lang.String getAffirmativeTextAndAccessKey()
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
For accessibility reasons, the access key functionality is not supported in screen reader mode.If the same accessKey appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This accessKey is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
public final void setAffirmativeTextAndAccessKey(java.lang.String affirmativeTextAndAccessKey)
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
For accessibility reasons, the access key functionality is not supported in screen reader mode.If the same accessKey appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This accessKey is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
affirmativeTextAndAccessKey
- the new affirmativeTextAndAccessKey valuepublic final java.lang.String getCancelTextAndAccessKey()
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
For accessibility reasons, the access key functionality is not supported in screen reader mode.If the same accessKey appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This accessKey is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
public final void setCancelTextAndAccessKey(java.lang.String cancelTextAndAccessKey)
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
For accessibility reasons, the access key functionality is not supported in screen reader mode.If the same accessKey appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This accessKey is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
cancelTextAndAccessKey
- the new cancelTextAndAccessKey valuepublic final java.lang.String getNoTextAndAccessKey()
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
For accessibility reasons, the access key functionality is not supported in screen reader mode.If the same accessKey appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This accessKey is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
public final void setNoTextAndAccessKey(java.lang.String noTextAndAccessKey)
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
For accessibility reasons, the access key functionality is not supported in screen reader mode.If the same accessKey appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This accessKey is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
noTextAndAccessKey
- the new noTextAndAccessKey valuepublic final java.lang.String getType()
public final void setType(java.lang.String type)
type
- the new type valuepublic final boolean isModal()
public final void setModal(boolean modal)
modal
- the new modal value
@Deprecated
public final boolean isOkVisible()
@Deprecated
public final void setOkVisible(boolean okVisible)
okVisible
- the new okVisible value
@Deprecated
public final boolean isCancelVisible()
@Deprecated
public final void setCancelVisible(boolean cancelVisible)
cancelVisible
- the new cancelVisible valuepublic java.lang.String getFamily()
getFamily
in class UIXDialog
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXDialog
|
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 |