public interface IFlowPersonality extends IFlowRequestProcessor, IRenderer
Modifier and Type | Method and Description |
---|---|
IFlowComponent |
getComponent(java.lang.String id) |
IFlowAsDialog |
getCurrentDialog() |
IFlowAsDialog |
getCurrentSystemDialog() |
IFlow |
getFlow()
The real flow.
|
java.lang.String |
getId() |
IFlow |
getParent() |
IFlowComponent |
getPopup() |
void |
modalDialog(IFlowAsDialog dialog,
IDialogCallback callback)
Starts a modal dialog which means that the flow, starting from next request,
is suspended waiting for the modal dialog flow to complete.
It can be safely used when the flow is processing submits or events (ie it is the active flow) or when it is rendering itself. |
IFlowComponent |
popup(IFlow popup,
java.lang.String style,
int clientX,
int clientY,
IPopupCallback popupCallback)
Opens a popup, it is a sort of mode-less dialog which remains open until
a parent or sibling flow becomes active or an
IFlowEndState is
reached. |
IFlowComponent |
popup(IFlow popup,
java.lang.String style,
java.lang.String relativeTo,
IPopupCallback popupCallback)
Opens a popup, it is a sort of mode-less dialog which remains open until
a parent or sibling flow becomes active or an
IFlowEndState is
reached. |
IFlowComponent |
popup(IFlow popup,
java.lang.String style,
java.lang.String relativeTo,
PopupPreferredPos preferredPos,
IPopupCallback popupCallback)
Opens a popup, it is a sort of mode-less dialog which remains open until
a parent or sibling flow becomes active or an
IFlowEndState is
reached. |
void |
publishEvent(IComponentEvent event)
It makes sense only for
IFlowComponent , for other personalities
it simply does nothing.The event is sended to the parent Flow recursively until one with an
IComponentListener is found.An event can be published only in its IFlowRequestProcessor.processSubmit(IFlow, javax.servlet.http.HttpServletRequest, String, RawActionInfo, java.util.Map)
method and, as a consequence, in an IFormAction .If more than one event is sended for a single submit then only the last one is delivered. If the receiving flow is an IFlowComponent then he can send an event to
its parent in response of an event received from one of its child components. |
processFieldEvent, processGet, processSubmit
java.lang.String getId()
IFlow getFlow()
IFlow getParent()
void modalDialog(IFlowAsDialog dialog, IDialogCallback callback) throws ModalDialogStartedException
dialog
- - if the flow implements IDialogCallback
by itself
it is enforced as the sole call-back.callback
- - called-back when the modal dialog terminatesModalDialogStartedException
- if another modal dialog is already started.IFlowAsDialog getCurrentDialog()
IFlowAsDialog getCurrentSystemDialog()
IFlowComponent getComponent(java.lang.String id)
void publishEvent(IComponentEvent event)
IFlowComponent
, for other personalities
it simply does nothing.Flow
recursively until one with an
IComponentListener
is found.IFlowRequestProcessor.processSubmit(IFlow, javax.servlet.http.HttpServletRequest, String, RawActionInfo, java.util.Map)
method and, as a consequence, in an IFormAction
.IFlowComponent
then he can send an event to
its parent in response of an event received from one of its child components.event
- java.lang.IllegalStateException
- if used outside of its scope.IFlowComponent popup(IFlow popup, java.lang.String style, java.lang.String relativeTo, IPopupCallback popupCallback)
IFlowEndState
is
reached.popup
- - the flow to be popped out, it must have no personality since
it will became an IFlowComponent
.style
- - the optional css style stringrelativeTo
- - the optional id of the element which is the anchor
used to position the popup.CSACTag
tag.popupCallback
- - called when the popup flow ends, which doesn't always
correspond with the popup closing action.IFlowComponent popup(IFlow popup, java.lang.String style, java.lang.String relativeTo, PopupPreferredPos preferredPos, IPopupCallback popupCallback)
IFlowEndState
is
reached.popup
- - the flow to be popped out, it must have no personality since
it will became an IFlowComponent
.style
- - the optional css style stringrelativeTo
- - the optional id of the element which is the anchor
used to position the popup.CSACTag
tag.preferredPos
- - the preferred position relative to the anchor.popupCallback
- - called when the popup flow ends, which doesn't always
correspond with the popup closing action.IFlowComponent popup(IFlow popup, java.lang.String style, int clientX, int clientY, IPopupCallback popupCallback)
IFlowEndState
is
reached.popup
- - the flow to be popped out, it must have no personality since
it will became an IFlowComponent
.style
- - the optional css style stringclientX
- clientY
- popupCallback
- - called when the popup flow ends, which doesn't always
correspond with the popup closing action.IFlowComponent getPopup()