org.openlowcode.server.graphic.widget

Class SComponentBand

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SComponentBand

Direct Known Subclasses:

SObjectSearcher

public class SComponentBand
extends SPageNode

A band of components (page nodes) that are aligned.

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIRECTION_DOWN a vertical band top to down (most common)
static int	DIRECTION_LEFT an horizontal band right to left (rare)
static int	DIRECTION_RIGHT an horizontal band (typically used for button bands)
static int	DIRECTION_UP a vertical band bottom to top (rare)

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
SComponentBand(int direction, SPage parent) this creates a ComponentBand without a name in the namespace of the page
SComponentBand(int direction, SPage parent, java.lang.String nameforpath) this creates a ComponentBand used as a significant element in the page path

Method Summary

Modifier and Type	Method and Description
void	addElement(SPageNode element)
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
java.lang.String	toString()
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, wait, wait, wait

Field Detail

DIRECTION_RIGHT

public static final int DIRECTION_RIGHT

an horizontal band (typically used for button bands)

See Also:

Constant Field Values

DIRECTION_DOWN

public static final int DIRECTION_DOWN

a vertical band top to down (most common)

See Also:

Constant Field Values

DIRECTION_UP

public static final int DIRECTION_UP

a vertical band bottom to top (rare)

See Also:

Constant Field Values

DIRECTION_LEFT

public static final int DIRECTION_LEFT

an horizontal band right to left (rare)

See Also:

Constant Field Values

Constructor Detail

SComponentBand

public SComponentBand(int direction,
                      SPage parent,
                      java.lang.String nameforpath)

this creates a ComponentBand used as a significant element in the page path

Parameters:

direction - direction as defined in static int in this class

parent - parent page

nameforpath - name for path if required (allows to have a unique namespace for parents.

SComponentBand

public SComponentBand(int direction,
                      SPage parent)

this creates a ComponentBand without a name in the namespace of the page

Parameters:

direction - direction as defined in static int in this class

parent - parent page

Method Detail

addElement

public void addElement(SPageNode element)

Parameters:

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object