org.openlowcode.server.graphic.widget

Class SPopupButton

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SPopupButton

public class SPopupButton
extends SPageNode

A pop-up button displays a child page as a pop-up when pressed.

Author:

Open Lowcode SAS

Field Summary

Fields inherited from class org.openlowcode.server.graphic.SPageNode

DEFAULT_UNSAVED_EDITION_CONTINUE_MESSAGE, DEFAULT_UNSAVED_EDITION_STOP_MESSAGE, DEFAULT_UNSAVED_EDITION_WARNING_MESSAGE

Constructor Summary

Constructors

Constructor and Description
SPopupButton(SPage parentpage, SPageNode payload, java.lang.String label, java.lang.String rollovertip) creates a popup button allowing scroll on the popup content
SPopupButton(SPage parentpage, SPageNode payload, java.lang.String label, java.lang.String rollovertip, boolean allowscroll) creates a popup button specifying if scroll on popup content is allowed or not
SPopupButton(SPage parentpage, SPageNode payload, java.lang.String label, java.lang.String rollovertip, boolean allowscroll, boolean showunderwidget, SActionRef mainpopupaction) creates a popup button specifying if scroll is allowed, and specifying the main popup action
SPopupButton(SPage parentpage, SPageNode payload, java.lang.String label, java.lang.String rollovertip, boolean allowscroll, SActionRef mainpopupaction) creates a popup button specifying if scroll is allowed, and specifying the main popup action
SPopupButton(SPage parentpage, SPageNode payload, java.lang.String label, java.lang.String rollovertip, SActionRef mainpopupaction) creates a popup button allowing scroll, with a specified main popup action

Method Summary

Modifier and Type	Method and Description
java.lang.String	getWidgetCode()
boolean	hideComponent(SPageData input, SecurityBuffer buffer) This method allows to hide component in a layout if the user is not authorized
void	populateDown(SPageSignifPath parentpath, SPageNode[] widgetpathtoroot) this method should be recursively called from parent structure to all its children
void	setMainPopupAction(SActionRef mainpopupaction) sets the main popup action.
void	WritePayloadToCDL(MessageWriter writer, SPageData input, SecurityBuffer buffer) writes the payload of the representation (without opening and closing structure)

Methods inherited from class org.openlowcode.server.graphic.SPageNode

addCurrentWidgetToRoot, getPage, printPath, setParentSignifPath, setSignifPath, WriteToCDL

Methods inherited from class java.lang.Object

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

Constructor Detail

SPopupButton

public SPopupButton(SPage parentpage,
                    SPageNode payload,
                    java.lang.String label,
                    java.lang.String rollovertip)

creates a popup button allowing scroll on the popup content

Parameters:

parentpage - parent page of the popup buttons

payload - content of the popup window displayed when popup button is pressed

label - label of the popup button

rollovertip - rollover tip for the popup button

SPopupButton

public SPopupButton(SPage parentpage,
                    SPageNode payload,
                    java.lang.String label,
                    java.lang.String rollovertip,
                    boolean allowscroll)

creates a popup button specifying if scroll on popup content is allowed or not

Parameters:

parentpage - parent page of the popup buttons

payload - content of the popup window displayed when popup button is pressed

label - label of the popup button

rollovertip - rollover tip for the popup button

allowscroll - true if scroll is allowed on the popup payload, false else

SPopupButton

public SPopupButton(SPage parentpage,
                    SPageNode payload,
                    java.lang.String label,
                    java.lang.String rollovertip,
                    SActionRef mainpopupaction)

creates a popup button allowing scroll, with a specified main popup action

Parameters:

parentpage - parent page of the popup buttons

payload - content of the popup window displayed when popup button is pressed

label - label of the popup button

rollovertip - rollover tip for the popup button

mainpopupaction - main popup action

SPopupButton

public SPopupButton(SPage parentpage,
                    SPageNode payload,
                    java.lang.String label,
                    java.lang.String rollovertip,
                    boolean allowscroll,
                    SActionRef mainpopupaction)

creates a popup button specifying if scroll is allowed, and specifying the main popup action

Parameters:

parentpage - parent page of the popup buttons

payload - content of the popup window displayed when popup button is pressed

label - label of the popup button

rollovertip - rollover tip for the popup button

allowscroll - true if scroll is allowed or false if not

mainpopupaction - main popup action

SPopupButton

public SPopupButton(SPage parentpage,
                    SPageNode payload,
                    java.lang.String label,
                    java.lang.String rollovertip,
                    boolean allowscroll,
                    boolean showunderwidget,
                    SActionRef mainpopupaction)

creates a popup button specifying if scroll is allowed, and specifying the main popup action

Parameters:

parentpage - parent page of the popup buttons

payload - content of the popup window displayed when popup button is pressed

label - label of the popup button

rollovertip - rollover tip for the popup button

allowscroll - true if scroll is allowed or false if not

showunderwidget - if true, content of the popup is shown under the button, if false, shown at the middle of the page

mainpopupaction - main popup action

Method Detail

setMainPopupAction

public void setMainPopupAction(SActionRef mainpopupaction)

sets the main popup action. When this action is launched, the popup will close.

Parameters:

mainpopupaction - main action popup

WritePayloadToCDL

public void WritePayloadToCDL(MessageWriter writer,
                              SPageData input,
                              SecurityBuffer buffer)
                       throws java.io.IOException

Description copied from class: SPageNode

writes the payload of the representation (without opening and closing structure)

Specified by:

WritePayloadToCDL in class SPageNode

Parameters:

writer - the CDL writer on which to write the message

Throws:

java.io.IOException

getWidgetCode

public java.lang.String getWidgetCode()

Specified by:

getWidgetCode in class SPageNode

hideComponent

public boolean hideComponent(SPageData input,
                             SecurityBuffer buffer)

Description copied from class: SPageNode

This method allows to hide component in a layout if the user is not authorized

Specified by:

hideComponent in class SPageNode

Returns:

true if the component should be hidden, false is the component is to be shown

populateDown

public void populateDown(SPageSignifPath parentpath,
                         SPageNode[] widgetpathtoroot)

Description copied from class: SPageNode

this method should be recursively called from parent structure to all its children

Specified by:

populateDown in class SPageNode

Parameters:

parentpath - the parent significant path

widgetpathtoroot - an array of all the page nodes for traceability in case of problems