org.openlowcode.client.graphic.widget

Class CGanntChart

java.lang.Object

org.openlowcode.client.graphic.CPageNode

org.openlowcode.client.graphic.widget.CGanntChart

public class CGanntChart
extends CPageNode

A widget showing a GANNT chart

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOWDAYS used for calendar with bands for days show all days
static int	SHOWHOURSINCALENDAR used for calendar with only days in calendar shown only working slots in calendar shown
static int	SHOWSIMPLEHOURS used for calendar with bands for days and sub-band for hours constant hour shown for everyday

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

logger, nodepath

Constructor Summary

Constructors

Constructor and Description
CGanntChart(MessageReader reader, CPageSignifPath parentpath) creates a GANNT chart from the message rom the server

Method Summary

Modifier and Type	Method and Description
CPageNode	deepcopyWithCallback(Callback callback)
void	forceUpdateData(DataElt dataelt)
DataElt	getDataElt(DataEltType type, java.lang.String eltname, java.lang.String objectfieldname) Returns a filled data element of the specified data element type.
java.util.Date	getEndDate(ObjectDataElt object) get the end date of the given Object data element
java.lang.String	getFieldDisplayValue(java.lang.String fieldname, ObjectDataElt object) get a field display value
IntegerDataElt	getIntegerExternalContent(CPageData inputdata, CPageDataRef dataref) get an integer element from page data
java.lang.String	getLabel(ObjectDataElt object) get the label to show on the GANNT from the data element
javafx.scene.Node	getNode(PageActionManager actionmanager, CPageData inputdata, javafx.stage.Window parentwindow, javafx.scene.control.TabPane[] parenttabpanes)
ArrayDataElt<ObjectDataElt>	getObjectArrayExternalContent(CPageData inputdata, CPageDataRef dataref) extracts an array of objects
java.util.Date	getStartDate(ObjectDataElt object) get the start date of the the given Object data element
java.util.Calendar	getStartOfDay(java.util.Date date) get the start of day for the given date
TextDataElt	getTextExternalContent(CPageData inputdata, CPageDataRef dataref) get a text element from page data
void	mothball() cleans the page node.
int	numberofdays(java.util.Date startdate, java.util.Date enddate) get the number of days necessary to cover both given dates

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

Field Detail

SHOWDAYS

public static final int SHOWDAYS

used for calendar with

• bands for days
• show all days

See Also:

Constant Field Values

SHOWSIMPLEHOURS

public static final int SHOWSIMPLEHOURS

used for calendar with

• bands for days and sub-band for hours
• constant hour shown for everyday

See Also:

Constant Field Values

SHOWHOURSINCALENDAR

public static final int SHOWHOURSINCALENDAR

used for calendar with

• only days in calendar shown
• only working slots in calendar shown

See Also:

Constant Field Values

Constructor Detail

CGanntChart

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

creates a GANNT chart from the message rom the server

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

getStartDate

public java.util.Date getStartDate(ObjectDataElt object)

get the start date of the the given Object data element

Parameters:

object - data object

Returns:

start date

getEndDate

public java.util.Date getEndDate(ObjectDataElt object)

get the end date of the given Object data element

Parameters:

object - data object

Returns:

end date

getLabel

public java.lang.String getLabel(ObjectDataElt object)

get the label to show on the GANNT from the data element

Parameters:

object - data object

Returns:

the label of the data element

getFieldDisplayValue

public java.lang.String getFieldDisplayValue(java.lang.String fieldname,
                                             ObjectDataElt object)

get a field display value

Parameters:

fieldname - unique java field name

object - data object

Returns:

the display value of the field

getStartOfDay

public java.util.Calendar getStartOfDay(java.util.Date date)

get the start of day for the given date

Parameters:

date - a given date

Returns:

the start of the day

numberofdays

public int numberofdays(java.util.Date startdate,
                        java.util.Date enddate)

get the number of days necessary to cover both given dates

Parameters:

startdate - start date

enddate - end date

Returns:

the number of days necessary to include startdate and enddate. E.g. from 23-MAY 23:00 to 25-MAY 01:00, number of days is 3. Note: there are simple hacks to manage europe summer time that may have side effects for activities from midnight to 2am, and it will not work for other timezones.

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)

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

forceUpdateData

public void forceUpdateData(DataElt dataelt)

Specified by:

forceUpdateData in class CPageNode

Parameters:

dataelt - adds data element to the node

getObjectArrayExternalContent

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

extracts an array of objects

Parameters:

inputdata - page data

dataref - data reference to use

Returns:

an array of data objects

getIntegerExternalContent

public IntegerDataElt getIntegerExternalContent(CPageData inputdata,
                                                CPageDataRef dataref)

get an integer element from page data

Parameters:

inputdata - page data

dataref - data reference to use

Returns:

an integer data element

getTextExternalContent

public TextDataElt getTextExternalContent(CPageData inputdata,
                                          CPageDataRef dataref)

get a text element from page data

Parameters:

inputdata - page data

dataref - data reference to use

Returns:

a text data element

getDataElt

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

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: