org.openlowcode.server.graphic.widget

Class SAreaChart<E extends DataObject<E>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SAreaChart<E>

Type Parameters:

E - data object holding the data shown in the chart

All Implemented Interfaces:

SDefaultPath

public class SAreaChart<E extends DataObject<E>>
extends SPageNode
implements SDefaultPath

A chart showing values according to x and y axis per category

Author:

Open Lowcode SAS

Field Summary

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
SAreaChart(java.lang.String name, ArrayDataElt<TObjectDataElt<E>> inputdata, DataObjectDefinition<E> objectmodel, DataObjectFieldMarker<E> xaxis, DataObjectFieldMarker<E> yaxiscategory, DataObjectFieldMarker<E> yaxisvalue, SPage parentpage) Creates the area chart

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPathName()
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

Constructor Detail

SAreaChart

public SAreaChart(java.lang.String name,
                  ArrayDataElt<TObjectDataElt<E>> inputdata,
                  DataObjectDefinition<E> objectmodel,
                  DataObjectFieldMarker<E> xaxis,
                  DataObjectFieldMarker<E> yaxiscategory,
                  DataObjectFieldMarker<E> yaxisvalue,
                  SPage parentpage)

Creates the area chart

Parameters:

name - name of the chart

inputdata - input data

objectmodel - defnition of the input data

xaxis - marker of a date field

yaxiscategory - marker providing category for yaxis

yaxisvalue - marker providing value to calculate for y axis

parentpage - parent page of the widget

Method Detail

getPathName

public java.lang.String getPathName()

Specified by:

getPathName in interface SDefaultPath

Returns:

the path for this element

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

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