org.openlowcode.server.graphic.widget

Class SObjectBand<E extends DataObject<E>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

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

Type Parameters:

E - data object being shown in the object band

All Implemented Interfaces:

SDefaultPath

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

a band of objects displayed one below the other. This is used for a presentation similar to comments in a web page

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
SObjectBand(java.lang.String name, ArrayDataElt<TObjectDataElt<E>> inputdata, DataObjectDefinition<E> objectmodel, SPage parent) creates an object band widget inside a page declaration

Method Summary

Modifier and Type	Method and Description
void	addDisplayProfile(DisplayProfile<E> profile) adds a display profile to hide some specific fields
<F extends SimpleDataEltType> java.util.function.Function<SActionInputDataRef<F>,SActionDataLoc<F>>	getAttributeInput(AttributeMarker<E,F> marker) gets a reference of the attribute for the object selected in the object band.
java.lang.String	getPathName()
java.lang.String	getWidgetCode()
void	hideAttribute(DataObjectFieldMarker<E> marker) allows to hide a specific attribute
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	setActionGroup(SPageNode actiongroup) sets a node as action group.
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

SObjectBand

public SObjectBand(java.lang.String name,
                   ArrayDataElt<TObjectDataElt<E>> inputdata,
                   DataObjectDefinition<E> objectmodel,
                   SPage parent)

creates an object band widget inside a page declaration

Parameters:

name - unique name in the context of parent significant widget

inputdata - input array of objecs to show

objectmodel - definition of the data object

parent - parent page

Method Detail

setActionGroup

public void setActionGroup(SPageNode actiongroup)

sets a node as action group. It will be repeated below each object

Parameters:

actiongroup - action group.

addDisplayProfile

public void addDisplayProfile(DisplayProfile<E> profile)

adds a display profile to hide some specific fields

Parameters:

profile - display profile to hide some specific fields

getAttributeInput

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

gets a reference of the attribute for the object selected in the object band.

Parameters:

marker - marker of the attribute to use as action attribute

Returns:

reference to the attribute of the object selected in the object band

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

hideAttribute

public void hideAttribute(DataObjectFieldMarker<E> marker)

allows to hide a specific attribute

Parameters:

marker - marker of the attribute to add

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