public interface DialogRenderKitService
UIXCommand components
will not support launching dialogs unless the render kit provides an
implementation of this API. Developers should always retrieve
an instance using Service.getService(java.lang.Object, java.lang.Class<T>),
passing in the current RenderKit.
RenderKit rk = facesContext.getRenderKit();
DialogService service = (DialogRenderKitService)
Service.getService(rk, DialogRenderKitService.class);
| Modifier and Type | Method and Description |
|---|---|
boolean |
isReturning(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent source)
Returns true if the RenderKit is aware that a dialog has
returned, and the given source component was responsible
for launching that dialog.
|
boolean |
launchDialog(javax.faces.context.FacesContext context,
javax.faces.component.UIViewRoot targetRoot,
javax.faces.component.UIComponent source,
Map<String,Object> processParameters,
boolean useWindow,
Map<String,Object> windowProperties)
Launch a dialog, if possible given the current agent's capabilities.
|
boolean |
returnFromDialog(javax.faces.context.FacesContext context,
Object returnValue)
Called to return from a dialog.
|
boolean launchDialog(javax.faces.context.FacesContext context,
javax.faces.component.UIViewRoot targetRoot,
javax.faces.component.UIComponent source,
Map<String,Object> processParameters,
boolean useWindow,
Map<String,Object> windowProperties)
ExtendedRenderKitService.encodeScripts(javax.faces.context.FacesContext) can output
markup that will actually launch the dialog.context - the current FacesContextsource - the source componenttargetRoot - the UIViewRoot that should be displayedprocessParameters - a set of parameters to populate the
newly created pageFlowScopeuseWindow - if true, try to show the dialog in a separate
window. The meaning of this parameter can be interpreted
by the RenderKit, and does not necessarily have to map
to a full window.windowProperties - a map of UI parameters used to
modify the dialog. The list of property names that are
supported will depend on the RenderKit, but
common examples include "width" and "height".boolean returnFromDialog(javax.faces.context.FacesContext context,
Object returnValue)
context - the current FacesContextreturnValue - the value being returned from the dialogboolean isReturning(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent source)
context - the current FacesContextsource - the source componentCopyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.