org.openlowcode.client.graphic

Class CPageSignifPath

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.client.graphic.CPageSignifPath

All Implemented Interfaces:

NamedInterface

public class CPageSignifPath
extends Named

The significant path of a widget inside a page. It is designed so that you can, to some extend, change the layout of a page, and, if the function stays the same, the significant path will not change.
A significant path is a tree structure where each widget should have a unique name amongst siblings (children of the same parent).
This class is used for nodes and leaves of the tree

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
CPageSignifPath(CPage page) Generates the root node of the significant path for a page;
CPageSignifPath(java.lang.String name, CPage page, CPageSignifPath parentpath, CPageNode pagenode) Adds a path element for a page node (widget)

Method Summary

Modifier and Type	Method and Description
void	addChildItem(CPageSignifPath child) Add a child item that should have a unique name for this parent
CPageNode	getNodeAtPath(java.lang.String path) a recursive method to parse the path tree and get the page node at the given path.
static java.lang.String	getPathBelow(java.lang.String path) utility function to get a path without the head element.
static java.lang.String	getPathNextToken(java.lang.String path)
java.lang.String	printPath()
java.lang.String	toString()
java.lang.String	traceChildren()

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CPageSignifPath

public CPageSignifPath(CPage page)

Generates the root node of the significant path for a page;

Parameters:

page -

CPageSignifPath

public CPageSignifPath(java.lang.String name,
                       CPage page,
                       CPageSignifPath parentpath,
                       CPageNode pagenode)

Adds a path element for a page node (widget)

Parameters:

name - name of the path element

page - parent page of the widget

parentpath - parent path in the page hierarchy

pagenode - widget

Method Detail

traceChildren

public java.lang.String traceChildren()

Returns:

a compact string with the name = of all children

addChildItem

public void addChildItem(CPageSignifPath child)

Add a child item that should have a unique name for this parent

Parameters:

child - the child path to add in this node

printPath

public java.lang.String printPath()

Returns:

the path in text form. This is a succession of names of elements separated by character '/' and starting with a '/'

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNodeAtPath

public CPageNode getNodeAtPath(java.lang.String path)

a recursive method to parse the path tree and get the page node at the given path. A circuit breaker is implemented so that potential recursive structures do not cause the whole JVM to to fail

Parameters:

path - the path as a string

Returns:

the node

getPathNextToken

public static java.lang.String getPathNextToken(java.lang.String path)

Parameters:

path - a path as a string (e.g. /MAINBAND/BUTTONBAND/OKBUTTON)

Returns:

the next element of the path (in example above would be MAINBAND)

getPathBelow

public static java.lang.String getPathBelow(java.lang.String path)

utility function to get a path without the head element. e.g. /MAINBAND/BUTTONBAND/OKBUTTON -> /BUTTONBAND/OKBUTTON

Parameters:

path - origin path

Returns:

the path without the head element