org.openlowcode.client.runtime

Class PageActionManager

java.lang.Object

org.openlowcode.client.runtime.PageActionManager

All Implemented Interfaces:

java.util.EventListener, javafx.event.EventHandler<javafx.event.ActionEvent>

public class PageActionManager
extends java.lang.Object
implements javafx.event.EventHandler<javafx.event.ActionEvent>

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PageActionManager.ActionSourceTransformer for some widgets, a subcomponent will fire the event, but a parent widget has the action attached to it.

Constructor Summary

Constructors

Constructor and Description
PageActionManager(ClientDisplay clientdisplay, PageActionManager.ActionSourceTransformer actionsourcetransformer) Creates a new action manager

Method Summary

Modifier and Type	Method and Description
void	addUnsavedDataWarning(UnsavedDataWarning unsaveddatawarning)
boolean	checkContinueWarning()
protected UnsavedDataWarning	checkwarnings(CPageAction currentaction)
protected UnsavedDataWarning	checkwarnings(CPageInlineAction currentaction)
void	directfireEvent(CPageAction action) directly fires an event to be processed.
void	directfireEvent(CPageAction action, Callback callback)
void	directfireInlineEvent(CPageInlineAction action)
ClientDisplay	getClientDisplay()
ClientSession	getClientSession()
javafx.event.EventHandler<javafx.scene.input.MouseEvent>	getMouseHandler()
void	handle(javafx.event.ActionEvent event)
void	registerCallback(java.lang.Object object, Callback callback)
void	registerEvent(java.lang.Object object, CPageAction action)
void	registerEventWithModifier(java.lang.Object object, CPageAction action, PageActionModifier modifier) Register an event with modifier for display of action result in the same tab
void	registerEventWithModifier(java.lang.Object object, CPageAction action, PageActionModifier modifier, boolean openinnewtab) Register an event with modifier for display of action result in the same tab
void	registerInlineAction(java.lang.Object widget, CPageInlineAction inlineaction) registers an inline action
void	registerInlineActionWithModifier(java.lang.Object widget, CPageInlineAction inlineaction, PageActionModifier modifier)
void	registerInlineActionwithPopupClose(java.lang.Object widget, CPageInlineAction inlineaction) registers an inline action that should close the attached popup
void	removedUnsavedDataWarningForNode(CPageNode node)
void	reset() removes all stored information before displaying a new page
void	resetWarnings() reset all warnings for unsaved data
void	setPage(CPage page)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageActionManager

public PageActionManager(ClientDisplay clientdisplay,
                         PageActionManager.ActionSourceTransformer actionsourcetransformer)

Creates a new action manager

Parameters:

clientdisplay - parent display

actionsourcetransformer - transformer that gets, when relevant, the higher level widget (e.g. tableview) from the lowest level widget (e.g. tablecell)

Method Detail

getClientDisplay

public ClientDisplay getClientDisplay()

Returns:

the client display this page action manager is working on

getClientSession

public ClientSession getClientSession()

Returns:

the client session to be used by this page action manager to communicate with the server

addUnsavedDataWarning

public void addUnsavedDataWarning(UnsavedDataWarning unsaveddatawarning)

Parameters:

unsaveddatawarning - configures an unsaveddatawarning on a node. If an action is fired from another node, the unsaved data warning will display first

removedUnsavedDataWarningForNode

public void removedUnsavedDataWarningForNode(CPageNode node)

Parameters:

node - remove an unsaveddatawarning on a node.

reset

public void reset()

removes all stored information before displaying a new page

resetWarnings

public void resetWarnings()

reset all warnings for unsaved data

registerCallback

public void registerCallback(java.lang.Object object,
                             Callback callback)

Parameters:

object - object the callback is configured on

callback - callback object

registerEvent

public void registerEvent(java.lang.Object object,
                          CPageAction action)

Parameters:

object - the object (JAVAFX widget) that will fire an event

action - the action to launch in that case

registerEventWithModifier

public void registerEventWithModifier(java.lang.Object object,
                                      CPageAction action,
                                      PageActionModifier modifier)

Register an event with modifier for display of action result in the same tab

Parameters:

object - the object (JAVAFX widget) that will fire an event

action - the action to launch in that case

modifier - relevant modifier (like Control, Shift pressed)

registerEventWithModifier

public void registerEventWithModifier(java.lang.Object object,
                                      CPageAction action,
                                      PageActionModifier modifier,
                                      boolean openinnewtab)

Register an event with modifier for display of action result in the same tab

Parameters:

object - the object (JAVAFX widget) that will fire an event

action - the action to launch in that case

modifier - relevant modifier (like Control, Shift pressed)

openinnewtab - if true, action result shown in new tab (keeping current page in current tab), if false action result shown on current tab (overwriting current page)

Since:

1.1

getMouseHandler

public javafx.event.EventHandler<javafx.scene.input.MouseEvent> getMouseHandler()

Returns:

the mouse handler from this page action manager

checkwarnings

protected UnsavedDataWarning checkwarnings(CPageAction currentaction)

Parameters:

currentaction - the action being triggered

Returns:

relevant unsaved data warning, null else

checkwarnings

protected UnsavedDataWarning checkwarnings(CPageInlineAction currentaction)

Parameters:

currentaction - the inline action behind triggered

Returns:

unsaved data warning if it exists, null else

checkContinueWarning

public boolean checkContinueWarning()

Returns:

true if confirmed to continue, false if action should stop

directfireEvent

public void directfireEvent(CPageAction action)

directly fires an event to be processed. This is required by widgets with complex logic

Parameters:

action - the action fired

directfireEvent

public void directfireEvent(CPageAction action,
                            Callback callback)

Parameters:

action - the action to fire

callback - the callback

directfireInlineEvent

public void directfireInlineEvent(CPageInlineAction action)

Parameters:

action - an inline action

handle

public void handle(javafx.event.ActionEvent event)

Specified by:

handle in interface javafx.event.EventHandler<javafx.event.ActionEvent>

setPage

public void setPage(CPage page)

Parameters:

page - sets the page for the widget (does not perform any processing)

registerInlineAction

public void registerInlineAction(java.lang.Object widget,
                                 CPageInlineAction inlineaction)

registers an inline action

Parameters:

widget - widget to trigger the action

inlineaction - inline action to launch

registerInlineActionwithPopupClose

public void registerInlineActionwithPopupClose(java.lang.Object widget,
                                               CPageInlineAction inlineaction)

registers an inline action that should close the attached popup

Parameters:

widget - widget to trigger the action

inlineaction - inline action to launch

registerInlineActionWithModifier

public void registerInlineActionWithModifier(java.lang.Object widget,
                                             CPageInlineAction inlineaction,
                                             PageActionModifier modifier)

Parameters:

widget - widget to trigger the action

inlineaction - forcePopupClose

modifier - a modifier (like shift pressed...)