org.openlowcode.server.graphic.widget

Class SChoiceTextField<E extends FieldChoiceDefinition<E>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SChoiceTextField<E>

All Implemented Interfaces:

SDefaultPath

public class SChoiceTextField<E extends FieldChoiceDefinition<E>>
extends SPageNode
implements SDefaultPath

a widget displaying a list of value field stored as text. It offers the following:

• choice between preset values
• different stored value and display value
• a tooltip text that can be multiline for each value

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
SChoiceTextField(java.lang.String label, java.lang.String datafieldname, java.lang.String helper, E choicedefinition, ChoiceDataElt linkeddata, SPage parentpage, boolean readonly, SActionRef action) creates a choice text field
SChoiceTextField(java.lang.String label, java.lang.String datafieldname, java.lang.String helper, E choicedefinition, ChoiceValue defaultvalue, SPage parentpage, boolean businessparameter, boolean readonly, boolean showintitle, boolean showinbottomnotes, SActionRef action) creates a choice text field
SChoiceTextField(java.lang.String label, java.lang.String datafieldname, java.lang.String helper, E choicedefinition, SPage parentpage, boolean businessparameter, boolean readonly, boolean showintitle, boolean showinbottomnotes, SActionRef action) creates a choice text field

Method Summary

Modifier and Type	Method and Description
java.util.function.Function<SActionInputDataRef<ChoiceDataEltType>,SActionDataLoc<ChoiceDataEltType>>	getChoiceInput()
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	setCompactShow() if true, the field will be compact, if false, the field will align on general object layout
void	setCompactShow(boolean twolines) sets compact show, potentially showing the label on a top line, and the choice box on the bottom line
void	setLinkedData(ChoiceDataElt linkeddata) sets the linked data to put in the choice text field
void	setPreferedDisplayInTable(int prefereddisplayintable) if used in a data object, allows to set the default width of the column
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

SChoiceTextField

public SChoiceTextField(java.lang.String label,
                        java.lang.String datafieldname,
                        java.lang.String helper,
                        E choicedefinition,
                        ChoiceDataElt linkeddata,
                        SPage parentpage,
                        boolean readonly,
                        SActionRef action)

creates a choice text field

Parameters:

label - label of the field (what is shown in default language

datafieldname - name of the data field (without spaces or special characters

helper - tooltip shown in roll-over mouse

choicedefinition - definition of the choice value

linkeddata - linked data in the action

parentpage - parent page for the widget

readonly - if true, field is only read-only

action - action ot launch by default after value is chosen

SChoiceTextField

public SChoiceTextField(java.lang.String label,
                        java.lang.String datafieldname,
                        java.lang.String helper,
                        E choicedefinition,
                        ChoiceValue defaultvalue,
                        SPage parentpage,
                        boolean businessparameter,
                        boolean readonly,
                        boolean showintitle,
                        boolean showinbottomnotes,
                        SActionRef action)

creates a choice text field

Parameters:

label - label of the field (what is shown in default language

datafieldname - name of the data field (without spaces or special characters

helper - tooltip shown in roll-over mouse

choicedefinition - definition of the choice value

defaultvalue - value to show if not input is given

parentpage - parent business page

businessparameter - true if business parameter

readonly - true if read-only

showintitle - when part of a data object, show the field in title (and also in normal seciton)

showinbottomnotes - when part of a data obejct, show only in the bottom notes

action - default action to launch

SChoiceTextField

public SChoiceTextField(java.lang.String label,
                        java.lang.String datafieldname,
                        java.lang.String helper,
                        E choicedefinition,
                        SPage parentpage,
                        boolean businessparameter,
                        boolean readonly,
                        boolean showintitle,
                        boolean showinbottomnotes,
                        SActionRef action)

creates a choice text field

Parameters:

label - label of the field (what is shown in default language

datafieldname - name of the data field (without spaces or special characters

helper - tooltip shown in roll-over mouse

choicedefinition - definition of the choice value

parentpage - parent business page

businessparameter - true if business parameter

readonly - true if read-only

showintitle - when part of a data object, show the field in title (and also in normal seciton)

showinbottomnotes - when part of a data obejct, show only in the bottom notes

action - default action to launch

Method Detail

setLinkedData

public void setLinkedData(ChoiceDataElt linkeddata)

sets the linked data to put in the choice text field

Parameters:

linkeddata - linked data

setCompactShow

public void setCompactShow()

if true, the field will be compact, if false, the field will align on general object layout

setCompactShow

public void setCompactShow(boolean twolines)

sets compact show, potentially showing the label on a top line, and the choice box on the bottom line

Parameters:

twolines - true if two lines

setPreferedDisplayInTable

public void setPreferedDisplayInTable(int prefereddisplayintable)

if used in a data object, allows to set the default width of the column

Parameters:

prefereddisplayintable - width of the column in characters

getPathName

public java.lang.String getPathName()

Specified by:

getPathName in interface SDefaultPath

Returns:

the path for this element

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

getChoiceInput

public java.util.function.Function<SActionInputDataRef<ChoiceDataEltType>,SActionDataLoc<ChoiceDataEltType>> getChoiceInput()

Returns:

an attribute having the content of the choice field

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