org.openlowcode.server.graphic.widget

Class SDateField

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SDateField

All Implemented Interfaces:

SDefaultPath

public class SDateField
extends SPageNode
implements SDefaultPath

A field holding a date as payload. This date can have a time (1st January 1977 06:44) or not (just 1st January 1977), in which case the date stored in system is 1pm GMT

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EMPTY
static int	DEFAULT_TODAY

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
SDateField(java.lang.String label, java.lang.String datafieldname, java.lang.String helper, int defaultvalue, boolean businessparameter, boolean timeedit, SPage parent, boolean readonly, boolean showintitle, boolean showinbottomnotes, SActionRef action)
SDateField(java.lang.String label, java.lang.String datafieldname, java.lang.String helper, int defaultvalue, boolean businessparameter, SPage parent, boolean readonly, boolean showintitle, boolean showinbottomnotes, SActionRef action) creates a date field that only allows to enter a date (no time)

Method Summary

Modifier and Type	Method and Description
java.util.function.Function<SActionInputDataRef<DateDataEltType>,SActionDataLoc<DateDataEltType>>	getDateInput() provides a reference to the payload of this field to be used as an action on the page
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() shows the widget as compact (to be used in menus, bars...)
void	setCompactShow(boolean twolines) shows the widget as compact, potentially on two lines (one for label, one for date entry widget)
void	setDateBusinessData(DateDataElt data) sets the page input as data for this widget
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

Field Detail

DEFAULT_EMPTY

public static final int DEFAULT_EMPTY

See Also:

Constant Field Values

DEFAULT_TODAY

public static final int DEFAULT_TODAY

See Also:

Constant Field Values

Constructor Detail

SDateField

public SDateField(java.lang.String label,
                  java.lang.String datafieldname,
                  java.lang.String helper,
                  int defaultvalue,
                  boolean businessparameter,
                  SPage parent,
                  boolean readonly,
                  boolean showintitle,
                  boolean showinbottomnotes,
                  SActionRef action)

creates a date field that only allows to enter a date (no time)

Parameters:

label - label in the main language of the application

datafieldname - unique name of the widget in the scope of parent widget

helper - roll-over tip. Can be long

defaultvalue - default value to put if field is empty

businessparameter - business parameter (to analyze if still needed)

parent - parent widget

readonly - true if read-only

showintitle - if true, show in title of the object and the main section

showinbottomnotes - if true, show only in bottom notes

action - action to trigger when user modifies the value

SDateField

public SDateField(java.lang.String label,
                  java.lang.String datafieldname,
                  java.lang.String helper,
                  int defaultvalue,
                  boolean businessparameter,
                  boolean timeedit,
                  SPage parent,
                  boolean readonly,
                  boolean showintitle,
                  boolean showinbottomnotes,
                  SActionRef action)

Parameters:

label - label in the main language of the application

datafieldname - unique name of the widget in the scope of parent widget

helper - roll-over tip. Can be long

defaultvalue - default value to put if field is empty

businessparameter - business parameter (to analyze if still needed)

timeedit - if true, time edition, if false just date edition

parent - parent widget

readonly - true if read-only

showintitle - if true, show in title of the object and the main section

showinbottomnotes - if true, show only in bottom notes

action - action to trigger when user modifies the value

Method Detail

getDateInput

public java.util.function.Function<SActionInputDataRef<DateDataEltType>,SActionDataLoc<DateDataEltType>> getDateInput()

provides a reference to the payload of this field to be used as an action on the page

Returns:

a reference to the payload of this field

getPathName

public java.lang.String getPathName()

Specified by:

getPathName in interface SDefaultPath

Returns:

the path for this element

setDateBusinessData

public void setDateBusinessData(DateDataElt data)

sets the page input as data for this widget

Parameters:

data - page input attribute of date format

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

setCompactShow

public void setCompactShow()

shows the widget as compact (to be used in menus, bars...)

setCompactShow

public void setCompactShow(boolean twolines)

shows the widget as compact, potentially on two lines (one for label, one for date entry widget)

Parameters:

twolines - if true, shows widget on two lines

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