org.openlowcode.server.graphic.widget

Class SGrid<E extends DataObject<E>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

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

Type Parameters:

E - data object shown in the grid

All Implemented Interfaces:

SDefaultPath

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

A grid shows one or several values of an array of objects in a grid where other fields of the object are used as column or line criteria. For the grid to work property, there should be only one object with the given criteria for lines and columns

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
SGrid(java.lang.String name, SPage parentpage, ArrayDataElt<TObjectDataElt<E>> objectarray, DataObjectFieldMarker<E> linefield, DataObjectFieldMarker<E> columnfield, java.util.ArrayList<DataObjectFieldMarker<E>> valuefield, DataObjectDefinition<E> objectmodel)
SGrid(java.lang.String name, SPage parentpage, ArrayDataElt<TObjectDataElt<E>> objectarray, DataObjectFieldMarker<E> linefield, DataObjectFieldMarker<E> columnfield, DataObjectFieldMarker<E> uniquevaluefield, DataObjectDefinition<E> objectmodel) Creates a grid with a single column criteria
SGrid(java.lang.String name, SPage parentpage, ArrayDataElt<TObjectDataElt<E>> objectarray, DataObjectFieldMarker<E> linefield, DataObjectFieldMarker<E> columnfield, DataObjectFieldMarker<E> secondarycolumnfield, DataObjectFieldMarker<E> uniquevaluefield, DataObjectDefinition<E> objectmodel) creates a grid with two column criteria

Method Summary

Modifier and Type	Method and Description
void	addUpdateAction(SInlineActionRef inlineupdateaction, java.util.ArrayList<DataObjectFieldMarker<E>> relevantattributes, SActionOutputDataRef<ArrayDataEltType<TObjectDataEltType<E>>> inlineupdateactionoutputdata) adds an inline update action
void	addUpdateAction(SInlineActionRef inlineupdateaction, java.util.ArrayList<DataObjectFieldMarker<E>> relevantattributes, SActionOutputDataRef<ArrayDataEltType<TObjectDataEltType<E>>> inlineupdateactionoutputdata, boolean updatenote) adds an inline update action
<F extends SimpleDataEltType> java.util.function.Function<SActionInputDataRef<F>,SActionDataLoc<F>>	getAttributeInput(AttributeMarker<E,F> marker) gets the data location of an attribute for the cell selected by double click
java.lang.String	getPathName()
java.util.function.Function<SActionInputDataRef<ArrayDataEltType<TObjectDataEltType<E>>>,SActionDataLoc<ArrayDataEltType<TObjectDataEltType<E>>>>	getUpdatedObjectArrayInput() gives a reference to the updated objects in the grid
java.util.function.Function<SActionInputDataRef<TextDataEltType>,SActionDataLoc<TextDataEltType>>	getUpdateNoteInput() gives a reference to the update note input
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	setDefaultAction(SActionRef defaultaction) sets the default action after double click on a cell in the grid
void	setWarningForUnsavedEdition() sets a warning for unsaved edition with default messages
void	setWarningForUnsavedEdition(java.lang.String unsavedwarningmessage, java.lang.String unsavedwarningcontinuemessage, java.lang.String unsavedwarningstopmessage) sets a warning for unsaved edition with personalized messages
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

SGrid

public SGrid(java.lang.String name,
             SPage parentpage,
             ArrayDataElt<TObjectDataElt<E>> objectarray,
             DataObjectFieldMarker<E> linefield,
             DataObjectFieldMarker<E> columnfield,
             DataObjectFieldMarker<E> uniquevaluefield,
             DataObjectDefinition<E> objectmodel)

Creates a grid with a single column criteria

Parameters:

name - unique name of the widget

parentpage - page

objectarray - the array of objects to show

linefield - field to use as line

columnfield - field to use as column

uniquevaluefield - field to show: this is a single value

objectmodel - definition of the object being shown in the grid

SGrid

public SGrid(java.lang.String name,
             SPage parentpage,
             ArrayDataElt<TObjectDataElt<E>> objectarray,
             DataObjectFieldMarker<E> linefield,
             DataObjectFieldMarker<E> columnfield,
             DataObjectFieldMarker<E> secondarycolumnfield,
             DataObjectFieldMarker<E> uniquevaluefield,
             DataObjectDefinition<E> objectmodel)

creates a grid with two column criteria

Parameters:

name - unique name of the widget

parentpage - page

objectarray - the array of objects to show

linefield - field to use as line

columnfield - field to use as column

secondarycolumnfield - the field to use as secondary column criteria

uniquevaluefield - field to show: this is a single value

objectmodel - definition of the object being shown in the grid

SGrid

public SGrid(java.lang.String name,
             SPage parentpage,
             ArrayDataElt<TObjectDataElt<E>> objectarray,
             DataObjectFieldMarker<E> linefield,
             DataObjectFieldMarker<E> columnfield,
             java.util.ArrayList<DataObjectFieldMarker<E>> valuefield,
             DataObjectDefinition<E> objectmodel)

Parameters:

name - unique name of the widget

parentpage - page

objectarray - the array of objects to show

linefield - field to use as line

columnfield - field to use as column

valuefield - field to show: this is an arraylist with at least one element. Practically, more than 3 values will likely result in an unreadable layout

objectmodel - definition of the data object shown in the grid

Method Detail

getUpdatedObjectArrayInput

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

gives a reference to the updated objects in the grid

Returns:

a reference to the updated objects in the grid

getUpdateNoteInput

public java.util.function.Function<SActionInputDataRef<TextDataEltType>,SActionDataLoc<TextDataEltType>> getUpdateNoteInput()

gives a reference to the update note input

Returns:

a reference to the update note input

addUpdateAction

public void addUpdateAction(SInlineActionRef inlineupdateaction,
                            java.util.ArrayList<DataObjectFieldMarker<E>> relevantattributes,
                            SActionOutputDataRef<ArrayDataEltType<TObjectDataEltType<E>>> inlineupdateactionoutputdata)

adds an inline update action

Parameters:

inlineupdateaction - inline update action

relevantattributes - relevant attributes for the inline update (only those attributes are sent back to the action); To take all normal fields of object, enter null

inlineupdateactionoutputdata - output data of the inline action to put back in the grid after the update

addUpdateAction

public void addUpdateAction(SInlineActionRef inlineupdateaction,
                            java.util.ArrayList<DataObjectFieldMarker<E>> relevantattributes,
                            SActionOutputDataRef<ArrayDataEltType<TObjectDataEltType<E>>> inlineupdateactionoutputdata,
                            boolean updatenote)

adds an inline update action

Parameters:

inlineupdateaction - inline update action

relevantattributes - relevant attributes for the inline update (only those attributes are sent back to the action); To take all normal fields of object, enter null

inlineupdateactionoutputdata - output data of the inline action to put back in the grid after the update

updatenote - if true, request the user to enter an update note

setDefaultAction

public void setDefaultAction(SActionRef defaultaction)

sets the default action after double click on a cell in the grid

Parameters:

defaultaction - default action after double click on a cell in the grid

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

getAttributeInput

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

gets the data location of an attribute for the cell selected by double click

Parameters:

marker - attribute marker

Returns:

the data location of an attribute on the selected cell

setWarningForUnsavedEdition

public void setWarningForUnsavedEdition()

sets a warning for unsaved edition with default messages

setWarningForUnsavedEdition

public void setWarningForUnsavedEdition(java.lang.String unsavedwarningmessage,
                                        java.lang.String unsavedwarningcontinuemessage,
                                        java.lang.String unsavedwarningstopmessage)

sets a warning for unsaved edition with personalized messages

Parameters:

unsavedwarningmessage - message to shown when user is leaving the page

unsavedwarningcontinuemessage - label for the continue (and discard updates) button

unsavedwarningstopmessage - label for the stop button