org.openlowcode.client.graphic

Class CPage

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.client.graphic.CPage

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

ClientUpgradePage

public class CPage
extends Named

A page of the application. It contains layout element (CPageNode) that can hold data, and action that use the data on the page to either launch a new page (action) or enrich the data on the page (inline action). The page is sent by the server.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
CPage(java.lang.String name) creates a blank page with the given name
CPage(java.lang.String name, MessageReader reader, java.lang.String module, java.lang.String action, PageBuffer pagebuffer) creates and parses a page, and its associated data

Method Summary

Modifier and Type	Method and Description
CPageData	getAllInputData()
long	getBufferedDataUsed()
DataElt	getInputData(int index)
int	getInputDataSize()
CPageNode	getNode()
CPageNode	getNodeAtSignificantPath(java.lang.String path)
java.lang.String	getPagedescription()
CPageSignifPath	getRootPath()
void	processInlineAction(java.lang.String module, java.lang.String name, CPageData newdata)
void	setPageNode(CPageNode pagenode)

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, toString, wait, wait, wait

Constructor Detail

CPage

public CPage(java.lang.String name,
             MessageReader reader,
             java.lang.String module,
             java.lang.String action,
             PageBuffer pagebuffer)
      throws OLcRemoteException,
             java.io.IOException

creates and parses a page, and its associated data

Parameters:

name - name of the page

reader - Message reader that will be used to parse the page info from the Content tab

module - module of the action calling the page

action - name of the action calling the page

pagebuffer - the local page buffer from which the page content will be got from, in case the page is already in local buffer (in that case, the server sends characteristics (size, checksum) of the page to use

Throws:

OLcRemoteException - if anything bad happened on the server when sending the page

java.io.IOException - if nayhting bad happens during the transmission

CPage

public CPage(java.lang.String name)

creates a blank page with the given name

Parameters:

name - unique name of the page in the module

Method Detail

getPagedescription

public java.lang.String getPagedescription()

getBufferedDataUsed

public long getBufferedDataUsed()

Returns:

the number of bytes of information for this page. This is used by the management of buffer for pages

setPageNode

public void setPageNode(CPageNode pagenode)

Parameters:

pagenode - sets the root node of the page

getNode

public CPageNode getNode()

Returns:

the root node of the page

getAllInputData

public CPageData getAllInputData()

Returns:

the data associated to the page

getInputDataSize

public int getInputDataSize()

Returns:

the number of data elements on the page

getInputData

public DataElt getInputData(int index)

Parameters:

index - index of the data element to get

Returns:

the data element at index

getRootPath

public CPageSignifPath getRootPath()

Returns:

the root page element

getNodeAtSignificantPath

public CPageNode getNodeAtSignificantPath(java.lang.String path)

Parameters:

path - a path

Returns:

the page node at this path

processInlineAction

public void processInlineAction(java.lang.String module,
                                java.lang.String name,
                                CPageData newdata)

Parameters:

module - module of the action

name - name of the action

newdata - new data to add to the page