org.openlowcode.server.graphic.widget

Class SDecimalField

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SDecimalField

All Implemented Interfaces:

SDefaultPath

public class SDecimalField
extends SPageNode
implements SDefaultPath

A field allowing the edition of a decimal field

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
SDecimalField(java.lang.String label, java.lang.String datafieldname, java.lang.String helper, int precision, int scale, java.math.BigDecimal defaultvalue, boolean businessparameter, SPage parent, boolean readonly, boolean showintitle, boolean showinbottomnotes, SDecimalFormatter decimalformatter, SActionRef action) Creates a new Decimal Field

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	setPreferedDisplayInTable(int prefereddisplayintable)
void	setReadOnly() forces the field to read-only
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

SDecimalField

public SDecimalField(java.lang.String label,
                     java.lang.String datafieldname,
                     java.lang.String helper,
                     int precision,
                     int scale,
                     java.math.BigDecimal defaultvalue,
                     boolean businessparameter,
                     SPage parent,
                     boolean readonly,
                     boolean showintitle,
                     boolean showinbottomnotes,
                     SDecimalFormatter decimalformatter,
                     SActionRef action)

Creates a new Decimal Field

Parameters:

label - user-friendly label in the main application language

datafieldname - unique name of the field in the object

helper - long explanation for mouse roll-over

precision - precision in the sense of java BigDecimal (total number of digits)

scale - scale in the sense of java BigDecimal (number of digits right of comma)

defaultvalue - a default value if no data is provided

businessparameter - true if the field is standalone, false if the field is part of an object

parent - parent page of the component

readonly - true if field should be read-only

showintitle - if in an object, put the field in title

showinbottomnotes - if in an object, put the field in the bottom notes

decimalformatter - a decimal formatter

action - action to trigger in case the user double clicks

Method Detail

setPreferedDisplayInTable

public void setPreferedDisplayInTable(int prefereddisplayintable)

Parameters:

prefereddisplayintable - the width of the field in characters if displayed in a table

setReadOnly

public void setReadOnly()

forces the field to read-only

getPathName

public java.lang.String getPathName()

Specified by:

getPathName in interface SDefaultPath

Returns:

the path for this element

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

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