org.openlowcode.server.graphic.widget

Class SFixSplit

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SFixSplit

public class SFixSplit
extends SPageNode

A fix split with a main component and a side component. The side component gets the minimum space necessary for layout

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIRECTION_DOWN main component on the bottom
static int	DIRECTION_LEFT main component on the left
static int	DIRECTION_RIGHT main component on the right
static int	DIRECTION_UP main component on the top

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
SFixSplit(int direction, SPage parent) creates a fix split component

Method Summary

Modifier and Type	Method and Description
void	addMainComponent(SPageNode node) adds the main component
void	addSecundaryComponent(SPageNode node) adds the secondary (side) component
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	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

Field Detail

DIRECTION_RIGHT

public static final int DIRECTION_RIGHT

main component on the right

See Also:

Constant Field Values

DIRECTION_DOWN

public static final int DIRECTION_DOWN

main component on the bottom

See Also:

Constant Field Values

DIRECTION_UP

public static final int DIRECTION_UP

main component on the top

See Also:

Constant Field Values

DIRECTION_LEFT

public static final int DIRECTION_LEFT

main component on the left

See Also:

Constant Field Values

Constructor Detail

SFixSplit

public SFixSplit(int direction,
                 SPage parent)

creates a fix split component

Parameters:

direction - direction indicates the side of the screen where the main component is shown. The secundary component is limited to the minimum side.

parent - parent page for the widget

Method Detail

addMainComponent

public void addMainComponent(SPageNode node)

adds the main component

Parameters:

node - main component node

addSecundaryComponent

public void addSecundaryComponent(SPageNode node)

adds the secondary (side) component

Parameters:

node - secondary component

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