org.openlowcode.server.graphic.widget

Class SObjectDisplay<E extends DataObject<E>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

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

Type Parameters:

E - type of data objects shown

All Implemented Interfaces:

SDefaultPath

public class SObjectDisplay<E extends DataObject<E>>
extends SPageNode
implements SDefaultPath

A widget showing an object. It has a title, normal fields, fields shown after the more separator, and fields shown in bottom notes

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
SObjectDisplay(java.lang.String name, TObjectDataElt<E> inputdata, DataObjectDefinition<E> objectmodel, SPage parent, boolean readonly) creates an object display
SObjectDisplay(java.lang.String name, TObjectDataElt<E> inputdata, DataObjectDefinition<E> objectmodel, SPage parent, boolean readonly, SActionRef defaultaction) creates an object display with a default action

Method Summary

Modifier and Type	Method and Description
void	addFieldLabelOverrides(DataObjectFieldMarker<E> fieldmarker, TextDataElt newlabel) adds a new label for a field
void	addPageNodeRightOfTitle(SPageNode node) adds a node right of title.
<F extends SimpleDataEltType> java.util.function.Function<SActionInputDataRef<F>,SActionDataLoc<F>>	getAttributeInput(AttributeMarker<E,F> marker) gets the attribute of the object to be used as an argument for an action on the page
TObjectDataElt<E>	getInputData() get the data from this widget (used by security mechanisms)
java.util.function.Function<SActionInputDataRef<TObjectDataEltType<E>>,SActionDataLoc<TObjectDataEltType<E>>>	getObjectInput() gets the full object as input for an action on the page
<F extends SimpleDataEltType> java.util.function.Function<SActionInputDataRef<ArrayDataEltType<F>>,SActionDataLoc<ArrayDataEltType<F>>>	getOneElementArrayInput(AttributeMarker<E,F> marker) gets the attribute of the object as a one element array to be used as argument for an action on the page
java.lang.String	getPathName()
java.lang.String	getWidgetCode()
void	hideAttribute(DataObjectFieldMarker<E> marker) hides the specified field
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	setHideReadOnly() if true, read-only fields are hidden
void	setMinFieldPriority(int minfieldpriority) when this parameter is set, only the fields with a priority higher or equal than the specified field priority are displayed.
void	setMoreFieldPriority(int morefieldpriority) when this parameter is set, only the fields with a priority higher or equal than the specified field priority are displayed above the more collapsible pane
void	setReducedDisplay(boolean title) displays the object as summarized version (only the title)
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

SObjectDisplay

public SObjectDisplay(java.lang.String name,
                      TObjectDataElt<E> inputdata,
                      DataObjectDefinition<E> objectmodel,
                      SPage parent,
                      boolean readonly)

creates an object display

Parameters:

name - unique name of the widget inside the significant parent widget

inputdata - page attribute to show

objectmodel - definition of the data object

parent - parent page

readonly - if true, widget is readonly, if false, the widget is allowed

SObjectDisplay

public SObjectDisplay(java.lang.String name,
                      TObjectDataElt<E> inputdata,
                      DataObjectDefinition<E> objectmodel,
                      SPage parent,
                      boolean readonly,
                      SActionRef defaultaction)

creates an object display with a default action

Parameters:

name - unique name of the widget inside the significant parent widget

inputdata - page attribute to show

objectmodel - definition of the data object

parent - parent page

readonly - if true, widget is readonly, if false, the widget is allowed

defaultaction - action to trigger when clicking return on one of the fields

Method Detail

addFieldLabelOverrides

public void addFieldLabelOverrides(DataObjectFieldMarker<E> fieldmarker,
                                   TextDataElt newlabel)

adds a new label for a field

Parameters:

fieldmarker - field of the object to override

newlabel - new label for the field

setReducedDisplay

public void setReducedDisplay(boolean title)

displays the object as summarized version (only the title)

Parameters:

title - if true, show only the title

setMinFieldPriority

public void setMinFieldPriority(int minfieldpriority)

when this parameter is set, only the fields with a priority higher or equal than the specified field priority are displayed. This impacts both the column layout and the data sent.

Parameters:

minfieldpriority - a value between 1000 and -1000

setMoreFieldPriority

public void setMoreFieldPriority(int morefieldpriority)

when this parameter is set, only the fields with a priority higher or equal than the specified field priority are displayed above the more collapsible pane

Parameters:

morefieldpriority - a value between 1000 and -1000

setHideReadOnly

public void setHideReadOnly()

if true, read-only fields are hidden

hideAttribute

public void hideAttribute(DataObjectFieldMarker<E> marker)

hides the specified field

Parameters:

marker - field marker for the field

getAttributeInput

public <F extends SimpleDataEltType> java.util.function.Function<SActionInputDataRef<F>,SActionDataLoc<F>> getAttributeInput(AttributeMarker<E,F> marker)

gets the attribute of the object to be used as an argument for an action on the page

Parameters:

marker - marker of the field

Returns:

the reference to the content of one field of the object

getOneElementArrayInput

public <F extends SimpleDataEltType> java.util.function.Function<SActionInputDataRef<ArrayDataEltType<F>>,SActionDataLoc<ArrayDataEltType<F>>> getOneElementArrayInput(AttributeMarker<E,F> marker)

gets the attribute of the object as a one element array to be used as argument for an action on the page

Parameters:

marker - marker of the field

Returns:

the reference to the content of one field of the object as a one element array

getObjectInput

public java.util.function.Function<SActionInputDataRef<TObjectDataEltType<E>>,SActionDataLoc<TObjectDataEltType<E>>> getObjectInput()

gets the full object as input for an action on the page

Returns:

a reference to the content of the full object

addPageNodeRightOfTitle

public void addPageNodeRightOfTitle(SPageNode node)

adds a node right of title. This can be used to shown a special action button

Parameters:

node - node to add right of the title

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

getInputData

public TObjectDataElt<E> getInputData()

get the data from this widget (used by security mechanisms)

Returns:

the data from this widget

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