|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidad.context.DialogService
public abstract class DialogService
The DialogService API defines a number of APIs that are needed to implement Apache Trinidad dialogs, but will only rarely be called by page authors. They are instead intended for developers of controller frameworks and component developers.
Field Summary | |
---|---|
static String |
DIALOG_NAVIGATION_PREFIX_PARAM_NAME
Configuration parameter for setting the prefix used in dialog navigation. |
static String |
DISABLE_DIALOG_OUTCOMES_PARAM_NAME
Configuration parameter for setting the prefix used in dialog navigation. |
Constructor Summary | |
---|---|
protected |
DialogService()
Create an DialogService. |
Method Summary | |
---|---|
javax.faces.component.UIComponent |
getCurrentLaunchSource()
Returns the value last set by setCurrentLaunchSource(javax.faces.component.UIComponent) . |
String |
getDialogNavigationPrefix()
Returns the prefix that, when used for navigational outcomes, will trigger the dialog framework. |
abstract ReturnEvent |
getReturnEvent(javax.faces.component.UIComponent source)
Creates a ReturnEvent for
a component. |
abstract void |
launchDialog(javax.faces.component.UIViewRoot dialogRoot,
Map<String,Object> dialogParameters,
javax.faces.component.UIComponent source,
boolean useWindow,
Map<String,Object> windowProperties)
Launches a dialog without pushing a process scope. |
abstract javax.faces.component.UIViewRoot |
peekView()
Returns the UIViewRoot that is topmost on the stack, of pushed view, without popping it. |
abstract void |
popView(boolean navigateToPopped)
Pop a UIViewRoot from a stack. |
abstract void |
pushView(javax.faces.component.UIViewRoot viewRoot)
Push a UIViewRoot onto a stack in preparation for navigating to a subflow. |
abstract void |
queueLaunchEvent(javax.faces.component.UIViewRoot dialogRoot)
Queues a LaunchEvent that will result in a dialog being started, using current launch source as the source
for launching the dialogRoot parameter. |
abstract void |
queueReturnEvent(Object returnValue,
Map<Object,Object> returnParams)
Queues a ReturnEvent, using current launch source as the source
for launching the dialogRoot parameter. |
abstract boolean |
returnFromDialog(Object returnValue,
Map<Object,Object> returnParameters)
Returns from a dialog without popping a process scope. |
void |
setCurrentLaunchSource(javax.faces.component.UIComponent component)
A component that is delivering an ActionEvent to the default ActionListener should call this method to allow a NavigationHandler to properly launch a dialog, and should reset the value to null afterwards. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DIALOG_NAVIGATION_PREFIX_PARAM_NAME
public static final String DISABLE_DIALOG_OUTCOMES_PARAM_NAME
Constructor Detail |
---|
protected DialogService()
Method Detail |
---|
public abstract void pushView(javax.faces.component.UIViewRoot viewRoot)
public abstract void popView(boolean navigateToPopped)
navigateToPopped
is true,
this method may result in calls to
FacesContext.renderResponse()
or even
FacesContext.responseComplete()
.
navigateToPopped
- If true, navigate to the view popped
of the stack with FacesContext.setViewRoot()
.
If false, simply drop the view.public abstract javax.faces.component.UIViewRoot peekView()
public abstract ReturnEvent getReturnEvent(javax.faces.component.UIComponent source)
ReturnEvent
for
a component. This method will generally be called from
a Renderer's or UIComponent's decode() method if there is
any possibility that it launched a dialog on a prior request.
There is no requirement that the component directly supports
ReturnListener
; decode()
can simply use the return value and discard the event.
This method will return null in the case where no dialog had been launched with this component as the source. If it returns a non-null event, the component or renderer should not process the request any further in decode(), but simply process the ReturnEvent, either by using its return value or queueing it for delivery.
source
- the component that may have launched a dialog
return value
from the
dialog.public javax.faces.component.UIComponent getCurrentLaunchSource()
setCurrentLaunchSource(javax.faces.component.UIComponent)
.
=-=AEW Make this abstract?
public void setCurrentLaunchSource(javax.faces.component.UIComponent component)
public abstract void launchDialog(javax.faces.component.UIViewRoot dialogRoot, Map<String,Object> dialogParameters, javax.faces.component.UIComponent source, boolean useWindow, Map<String,Object> windowProperties)
RequestContext.launchDialog()
.
The process scope must be pushed
before calling this method.
public abstract boolean returnFromDialog(Object returnValue, Map<Object,Object> returnParameters)
RequestContext.returnFromDialog()
.
The process scope must be popped
after calling this method.
public abstract void queueLaunchEvent(javax.faces.component.UIViewRoot dialogRoot)
current launch source
as the source
for launching the dialogRoot parameter.
The process scope must be pushed
before calling this method. If getCurrentLaunchSource()
returns null
, a basic dialog will be started without
using a window or passing any additional parameters. Developers
should not call
FacesContext.setViewRoot()
when using this method.
public abstract void queueReturnEvent(Object returnValue, Map<Object,Object> returnParams)
current launch source
as the source
for launching the dialogRoot parameter. This method should
be used by a NavigationHandler
that can identify
a return value from a dialog without actually launching the dialog.
public String getDialogNavigationPrefix()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |