org.openlowcode.client.graphic.widget

Class CGrid

java.lang.Object

org.openlowcode.client.graphic.CPageNode

org.openlowcode.client.graphic.widget.CGrid

public class CGrid
extends CPageNode

A grid is a way to display objects, with one object displayed per cell, ordered in a specific place on the grid based on the value of specific attributes.
This assumes that there is only one object for the combination of lines and columns

Author:

Open Lowcode SAS

Field Summary

Fields inherited from class org.openlowcode.client.graphic.CPageNode

logger, nodepath

Constructor Summary

Constructors

Constructor and Description
CGrid(MessageReader reader, CPageSignifPath parentpath) create a grid component

Method Summary

Modifier and Type	Method and Description
void	copyTableToClipboard() copy the content of the grid to the clipboard
CPageNode	deepcopyWithCallback(Callback callback)
void	forceUpdateData(DataElt dataelt)
DataElt	getDataElt(DataEltType type, java.lang.String eltname, java.lang.String objectdataloc) Returns a filled data element of the specified data element type.
ArrayDataElt<ObjectDataElt>	getExternalContent(CPageData inputdata, CPageDataRef dataref) parses the page data to get an array of object data elements
javafx.scene.Node	getNode(PageActionManager actionmanager, CPageData inputdata, javafx.stage.Window parentwindow, javafx.scene.control.TabPane[] parenttabpanes)
void	launchupdate(javafx.event.ActionEvent event, javafx.scene.input.MouseEvent mouseevent) change the update state of the grid following user interaction
void	mothball() cleans the page node.
void	reviewDataWarningForGrid() When this method is triggered, it reviews the number of rows in the table that have been edited, and according to total data table, create or remove the data update warning

Methods inherited from class org.openlowcode.client.graphic.CPageNode

getParentpath, getPath, getSignificantpath, parseNode, setPageCatelog

Methods inherited from class java.lang.Object

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

Constructor Detail

CGrid

public CGrid(MessageReader reader,
             CPageSignifPath parentpath)
      throws OLcRemoteException,
             java.io.IOException

create a grid component

Parameters:

reader - message reader from the server

parentpath - parent path

Throws:

OLcRemoteException - if anything bad happens on the server

java.io.IOException - if any transmission error appears while reading the message

Method Detail

deepcopyWithCallback

public CPageNode deepcopyWithCallback(Callback callback)

Specified by:

deepcopyWithCallback in class CPageNode

Parameters:

callback - the callback method, may be null

Returns:

a deep copy of the CPageNode with callback specified set

copyTableToClipboard

public void copyTableToClipboard()

copy the content of the grid to the clipboard

launchupdate

public void launchupdate(javafx.event.ActionEvent event,
                         javafx.scene.input.MouseEvent mouseevent)

change the update state of the grid following user interaction

Parameters:

event - action event

mouseevent - mouse event

getNode

public javafx.scene.Node getNode(PageActionManager actionmanager,
                                 CPageData inputdata,
                                 javafx.stage.Window parentwindow,
                                 javafx.scene.control.TabPane[] parenttabpanes)

Specified by:

getNode in class CPageNode

Parameters:

actionmanager - the action manager on which to register all widgets that trigger an action

inputdata - the list of input data of the page

parentwindow - the javafx window this widget will be drawn in

parenttabpanes - parenttabpanes that should be triggered a layout when this component resizes

Returns:

a displayable node (in JAVAFX)

getExternalContent

public ArrayDataElt<ObjectDataElt> getExternalContent(CPageData inputdata,
                                                      CPageDataRef dataref)

parses the page data to get an array of object data elements

Parameters:

inputdata - page input data

dataref - reference of the data to use in the page input data

Returns:

an array of object data elements

getDataElt

public DataElt getDataElt(DataEltType type,
                          java.lang.String eltname,
                          java.lang.String objectdataloc)

Description copied from class: CPageNode

Returns a filled data element of the specified data element type. If there is a format mismatch, an exception is thrown

Specified by:

getDataElt in class CPageNode

Parameters:

type - requested type (will be tested by the widget to see if valid)

eltname - the name that will be put to the data element

Returns:

forceUpdateData

public void forceUpdateData(DataElt dataelt)

Specified by:

forceUpdateData in class CPageNode

Parameters:

dataelt - adds data element to the node

mothball

public void mothball()

Description copied from class: CPageNode

cleans the page node. Due to the complex structure, some unlinking of different classes is needed to facilitate garbage collection after page is discarded

Specified by:

mothball in class CPageNode

reviewDataWarningForGrid

public void reviewDataWarningForGrid()

When this method is triggered, it reviews the number of rows in the table that have been edited, and according to total data table, create or remove the data update warning