org.openlowcode.server.graphic.widget

Class SActionButton

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SActionButton

All Implemented Interfaces:

SDefaultPath

public class SActionButton
extends SPageNode
implements SDefaultPath

A button to trigger an action on a page

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
SActionButton(java.lang.String label, SActionRef action, boolean forcepopupcloseforinline, SPage parent) creates an action button that will close the popup the button is part of
SActionButton(java.lang.String label, SActionRef action, SPage parent) creates an action button
SActionButton(java.lang.String label, java.lang.String rollovertip, SActionRef action, boolean forcepopupcloseforinline, SPage parent) Creates an action button that will close the popup the button is part of and with a roll-over tip
SActionButton(java.lang.String label, java.lang.String rollovertip, SActionRef action, SPage parent) creates an action button with the given roll-over tip

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPathName()
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	setConditionalShow(ChoiceDataElt<?> conditionalshow) puts condition to show the button depending on data sent to the page
void	setConfirmationMessage(java.lang.String confirmationmessage) will send a confirmation message when button is clicked with continue and cancel as options.
void	setConfirmationMessage(java.lang.String confirmationmessage, java.lang.String oklabel, java.lang.String kolabel) sets a confirmation with defined OK and KO label.
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

SActionButton

public SActionButton(java.lang.String label,
                     SActionRef action,
                     SPage parent)

creates an action button

Parameters:

label - label in main language

action - action reference

parent - parent page

SActionButton

public SActionButton(java.lang.String label,
                     java.lang.String rollovertip,
                     SActionRef action,
                     SPage parent)

creates an action button with the given roll-over tip

Parameters:

label - label in main language

rollovertip - tip shown in mouse roll-over

action - action reference

parent - parent page

SActionButton

public SActionButton(java.lang.String label,
                     SActionRef action,
                     boolean forcepopupcloseforinline,
                     SPage parent)

creates an action button that will close the popup the button is part of

Parameters:

label - label in main language

action - action reference

forcepopupcloseforinline - will close the popup window the button is part on while executing an inline action

parent - parent page

SActionButton

public SActionButton(java.lang.String label,
                     java.lang.String rollovertip,
                     SActionRef action,
                     boolean forcepopupcloseforinline,
                     SPage parent)

Creates an action button that will close the popup the button is part of and with a roll-over tip

Parameters:

label - label in main language

rollovertip - tip shown in mouse roll-over

action - action reference

forcepopupcloseforinline - will close the popup window the button is part on while executing an inline action

parent - parent page

Method Detail

setConditionalShow

public void setConditionalShow(ChoiceDataElt<?> conditionalshow)

puts condition to show the button depending on data sent to the page

Parameters:

choiceDataElt - a system boolean choice value. button will display if value is YES

setConfirmationMessage

public void setConfirmationMessage(java.lang.String confirmationmessage)

will send a confirmation message when button is clicked with continue and cancel as options. Action will proceed only if continue is pressed

Parameters:

confirmationmessage - the confirmation message

setConfirmationMessage

public void setConfirmationMessage(java.lang.String confirmationmessage,
                                   java.lang.String oklabel,
                                   java.lang.String kolabel)

sets a confirmation with defined OK and KO label. Action will proceed only if OK label is pressed

Parameters:

confirmationmessage - message shown in confirmation popup

oklabel - label to press to continue

kolabel - label to press to stio

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

getPathName

public java.lang.String getPathName()

Specified by:

getPathName in interface SDefaultPath

Returns:

the path for this element

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