public class RichDialog extends UIXDialog implements javax.faces.component.behavior.ClientBehaviorHolder
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 and only a single child occurrence is supported. 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.
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.
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. You can force the af:popup to reset any input components in its content when canceled using the resetEditableValues
property set to "whenCanceled".
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.
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. There are a couple ways to solve this problem.
resetEditableValues
of the owning af:popup
to "whenCanceled". This will force input component within the content of the popup to be reset when the popup is canceled.af:resetListener
. You can choose from any event type but action, popupFetch, popupCanceled, and dialog are all popup choices.Custom cancel dialog buttons 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 and use one of the two method previously described for resetting input components.
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. 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 dialog 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 |
---|---|---|
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 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 |
AFFIRMATIVE_TEXT_AND_ACCESS_KEY_KEY |
static 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 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 |
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 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 String |
TYPE_CANCEL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TYPE_KEY |
static String |
TYPE_NONE |
static String |
TYPE_OK |
static String |
TYPE_OK_CANCEL |
static String |
TYPE_YES_NO |
static String |
TYPE_YES_NO_CANCEL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY
Deprecated.
|
DIALOG_LISTENER_KEY
Modifier | Constructor and Description |
---|---|
|
RichDialog()
Construct an instance of the RichDialog.
|
protected |
RichDialog(String rendererType)
Construct an instance of the RichDialog.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
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.
|
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.
|
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 |
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.
|
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.
|
String |
getType()
Gets the buttons in the dialog.
|
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 |
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.
|
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(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(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(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 if the dialog is modal.
|
void |
setNoTextAndAccessKey(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(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 |
setType(String type)
Sets the buttons in the dialog.
|
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.
|
broadcast, processDismissal, queueEvent, setDialogListener
addDialogListener, getDialogListener, getDialogListeners, removeDialogListener, setDialogListener
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, 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, 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, getPassThroughAttributes, getPassThroughAttributes, 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 String TYPE_NONE
public static final String TYPE_OK
public static final String TYPE_CANCEL
public static final String TYPE_YES_NO
public static final String TYPE_OK_CANCEL
public static final 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 String BUTTON_BAR_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichDialog()
protected RichDialog(String rendererType)
public final javax.faces.component.UIComponent getButtonBar()
public final void setButtonBar(javax.faces.component.UIComponent buttonBarFacet)
public 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 final String getAffirmativeTextAndAccessKey()
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
public final void setAffirmativeTextAndAccessKey(String affirmativeTextAndAccessKey)
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
affirmativeTextAndAccessKey
- the new affirmativeTextAndAccessKey valuepublic final String getCancelTextAndAccessKey()
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
public final void setCancelTextAndAccessKey(String cancelTextAndAccessKey)
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
cancelTextAndAccessKey
- the new cancelTextAndAccessKey valuepublic final String getNoTextAndAccessKey()
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
public final void setNoTextAndAccessKey(String noTextAndAccessKey)
For example, setting this attribute to "T&ext" will set the textual label to "Text" and the accessKey to 'e'.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
noTextAndAccessKey
- the new noTextAndAccessKey valuepublic final String getType()
public final void setType(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 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 PartialUIXDialog
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXDialog