public class SComponentBand extends SPageNode
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)
|
DEFAULT_UNSAVED_EDITION_CONTINUE_MESSAGE, DEFAULT_UNSAVED_EDITION_STOP_MESSAGE, DEFAULT_UNSAVED_EDITION_WARNING_MESSAGE
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
|
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)
|
addCurrentWidgetToRoot, getPage, printPath, setParentSignifPath, setSignifPath, WriteToCDL
public static final int DIRECTION_RIGHT
public static final int DIRECTION_DOWN
public static final int DIRECTION_UP
public static final int DIRECTION_LEFT
public SComponentBand(int direction, SPage parent, java.lang.String nameforpath)
direction
- direction as defined in static int in this classparent
- parent pagenameforpath
- name for path if required (allows to have a unique
namespace for parents.public SComponentBand(int direction, SPage parent)
direction
- direction as defined in static int in this classparent
- parent pagepublic void addElement(SPageNode element)
element
- public void WritePayloadToCDL(MessageWriter writer, SPageData input, SecurityBuffer buffer) throws java.io.IOException
SPageNode
WritePayloadToCDL
in class SPageNode
writer
- the CDL writer on which to write the messagejava.io.IOException
public java.lang.String getWidgetCode()
getWidgetCode
in class SPageNode
public boolean hideComponent(SPageData input, SecurityBuffer buffer)
SPageNode
hideComponent
in class SPageNode
public void populateDown(SPageSignifPath parentpath, SPageNode[] widgetpathtoroot)
SPageNode
populateDown
in class SPageNode
parentpath
- the parent significant pathwidgetpathtoroot
- an array of all the page nodes for traceability in
case of problemspublic java.lang.String toString()
toString
in class java.lang.Object