org.openlowcode.server.graphic.widget

Class SGanntChart<E extends DataObject<E> & UniqueidentifiedInterface<E>,F extends DataObject<F> & UniqueidentifiedInterface<F>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SGanntChart<E,F>

Type Parameters:

E - data object storing tasks

F - data object storing dependencies if they are found

All Implemented Interfaces:

SDefaultPath

public class SGanntChart<E extends DataObject<E> & UniqueidentifiedInterface<E>,F extends DataObject<F> & UniqueidentifiedInterface<F>>
extends SPageNode
implements SDefaultPath

a GANNT chart displaying tasks and dependencies

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.server.graphic.SPageNode

DEFAULT_UNSAVED_EDITION_CONTINUE_MESSAGE, DEFAULT_UNSAVED_EDITION_STOP_MESSAGE, DEFAULT_UNSAVED_EDITION_WARNING_MESSAGE

Constructor Summary

Constructors

Constructor and Description
SGanntChart(java.lang.String name, IntegerDataElt hourstartdata, IntegerDataElt hourenddata, ArrayDataElt<TObjectDataElt<E>> tasklist, DataObjectFieldMarker<E> taskstarttimefield, DataObjectFieldMarker<E> taskendtimefield, DataObjectFieldMarker<E> label1, DataObjectFieldMarker<E> label2, DataObjectDefinition<E> taskdefinition, SPage parent) Creates a GANNT chart with variable start and end hour for displaying tasks per day
SGanntChart(java.lang.String name, int hourstart, int hourend, ArrayDataElt<TObjectDataElt<E>> tasklist, DataObjectFieldMarker<E> taskstarttimefield, DataObjectFieldMarker<E> taskendtimefield, DataObjectFieldMarker<E> label1, DataObjectFieldMarker<E> label2, DataObjectDefinition<E> taskdefinition, SPage parent) Creates a GANNT chart with fixed start hour and end hour for displaying of day
SGanntChart(java.lang.String name, TextDataElt calendarcode, ArrayDataElt<TObjectDataElt<E>> tasklist, DataObjectFieldMarker<E> taskstarttimefield, DataObjectFieldMarker<E> taskendtimefield, DataObjectFieldMarker<E> label1, DataObjectFieldMarker<E> label2, DataObjectDefinition<E> taskdefinition, SPage parent) * Creates a GANNT chart with default start hour end end hour for display

Method Summary

Modifier and Type	Method and Description
void	addDefaultAction(SActionRef defaultaction) sets the default action when clicking on the task in the GANNT chart
void	addDependencies(ArrayDataElt<TObjectDataElt<F>> linkarray, DataObjectFieldMarker<F> linkobjectid1, DataObjectFieldMarker<F> linkobjectid2) adds a dependency array on the GANNT chart
void	addRescheduleAction(SActionRef rescheduleaction) adds a reschedule action that is triggered when dragging a task on the GANNT chart
java.lang.String	getPathName()
SActionDataLoc<DateDataEltType>	getReschedulePopupEndDate(SActionInputDataRef<DateDataEltType> inputdataref) gets the new end date inside the reschedule popup to use it as attribute of an action
java.util.function.Function<SActionInputDataRef<DateDataEltType>,SActionDataLoc<DateDataEltType>>	getReschedulePopupEndDateInput() gets the new end date inside the reschedule popup to use it as attribute of an action
SActionDataLoc<DateDataEltType>	getReschedulePopupStartDate(SActionInputDataRef<DateDataEltType> inputdataref) gets the new start date inside the reschedule popup to use it as attribute of an action
java.util.function.Function<SActionInputDataRef<DateDataEltType>,SActionDataLoc<DateDataEltType>>	getReschedulePopupStartDateInput() gets the new start date in the reschedule popup
java.util.function.Function<SActionInputDataRef<TObjectIdDataEltType<E>>,SActionDataLoc<TObjectIdDataEltType<E>>>	getRootTimeslotIdInput() get the id of the root timeslot element (start of the GANNT chart)
java.util.function.Function<SActionInputDataRef<TObjectIdDataEltType<E>>,SActionDataLoc<TObjectIdDataEltType<E>>>	getSelectedTimeslotIdInput() gets the id of the selected timeslot as attribute for an action
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	setColorField(DataObjectFieldMarker<E> colorfield) sets the attribute to be used
void	setDotMarkField(DataObjectFieldMarker<E> dotmarkfield) sets the attribute to be used for dot mark field (tasks can be displayed with a color for the task and also a dot)
void	setMinWidth(int minwidth) sets the minimum width of the GANNT chart
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

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

SGanntChart

public SGanntChart(java.lang.String name,
                   IntegerDataElt hourstartdata,
                   IntegerDataElt hourenddata,
                   ArrayDataElt<TObjectDataElt<E>> tasklist,
                   DataObjectFieldMarker<E> taskstarttimefield,
                   DataObjectFieldMarker<E> taskendtimefield,
                   DataObjectFieldMarker<E> label1,
                   DataObjectFieldMarker<E> label2,
                   DataObjectDefinition<E> taskdefinition,
                   SPage parent)

Creates a GANNT chart with variable start and end hour for displaying tasks per day

Parameters:

name - name of the widget

hourstartdata - variable start hour

hourenddata - variable end hour

tasklist - list of tasks

taskstarttimefield - field to use as task start time

taskendtimefield - field to use as task end time

label1 - first label on the task

label2 - second label on the task

taskdefinition - definition of the task

parent - page the widget is displayed on

SGanntChart

public SGanntChart(java.lang.String name,
                   TextDataElt calendarcode,
                   ArrayDataElt<TObjectDataElt<E>> tasklist,
                   DataObjectFieldMarker<E> taskstarttimefield,
                   DataObjectFieldMarker<E> taskendtimefield,
                   DataObjectFieldMarker<E> label1,
                   DataObjectFieldMarker<E> label2,
                   DataObjectDefinition<E> taskdefinition,
                   SPage parent)

* Creates a GANNT chart with default start hour end end hour for display

Parameters:

name - name of the widget

tasklist - list of tasks

taskstarttimefield - field to use as task start time

taskendtimefield - field to use as task end time

label1 - first label on the task

label2 - second label on the task

taskdefinition - definition of the task

parent - page the widget is displayed on

SGanntChart

public SGanntChart(java.lang.String name,
                   int hourstart,
                   int hourend,
                   ArrayDataElt<TObjectDataElt<E>> tasklist,
                   DataObjectFieldMarker<E> taskstarttimefield,
                   DataObjectFieldMarker<E> taskendtimefield,
                   DataObjectFieldMarker<E> label1,
                   DataObjectFieldMarker<E> label2,
                   DataObjectDefinition<E> taskdefinition,
                   SPage parent)

Creates a GANNT chart with fixed start hour and end hour for displaying of day

Parameters:

name - name of the widget

hourstart - set start hour

hourend - set end hour

tasklist - list of tasks

taskstarttimefield - field to use as task start time

taskendtimefield - field to use as task end time

label1 - first label on the task

label2 - second label on the task

taskdefinition - definition of the task

parent - page the widget is displayed on

Method Detail

addDefaultAction

public void addDefaultAction(SActionRef defaultaction)

sets the default action when clicking on the task in the GANNT chart

Parameters:

defaultaction - default action

addRescheduleAction

public void addRescheduleAction(SActionRef rescheduleaction)

adds a reschedule action that is triggered when dragging a task on the GANNT chart

Parameters:

rescheduleaction - action to launch for reschedule

getSelectedTimeslotIdInput

public java.util.function.Function<SActionInputDataRef<TObjectIdDataEltType<E>>,SActionDataLoc<TObjectIdDataEltType<E>>> getSelectedTimeslotIdInput()

gets the id of the selected timeslot as attribute for an action

Returns:

the reference to put in the action

getRootTimeslotIdInput

public java.util.function.Function<SActionInputDataRef<TObjectIdDataEltType<E>>,SActionDataLoc<TObjectIdDataEltType<E>>> getRootTimeslotIdInput()

get the id of the root timeslot element (start of the GANNT chart)

Returns:

the reference to put in the action

getReschedulePopupStartDate

public SActionDataLoc<DateDataEltType> getReschedulePopupStartDate(SActionInputDataRef<DateDataEltType> inputdataref)

gets the new start date inside the reschedule popup to use it as attribute of an action

Parameters:

inputdataref - action input data ref

Returns:

the data location

getReschedulePopupStartDateInput

public java.util.function.Function<SActionInputDataRef<DateDataEltType>,SActionDataLoc<DateDataEltType>> getReschedulePopupStartDateInput()

gets the new start date in the reschedule popup

Returns:

the attribute to use as input of an action

getReschedulePopupEndDate

public SActionDataLoc<DateDataEltType> getReschedulePopupEndDate(SActionInputDataRef<DateDataEltType> inputdataref)

gets the new end date inside the reschedule popup to use it as attribute of an action

Parameters:

inputdataref - action input data ref

Returns:

the data location

getReschedulePopupEndDateInput

public java.util.function.Function<SActionInputDataRef<DateDataEltType>,SActionDataLoc<DateDataEltType>> getReschedulePopupEndDateInput()

gets the new end date inside the reschedule popup to use it as attribute of an action

Returns:

the attribute to use as input of an action

setMinWidth

public void setMinWidth(int minwidth)

sets the minimum width of the GANNT chart

Parameters:

minwidth - min width of the GANNT chart

addDependencies

public void addDependencies(ArrayDataElt<TObjectDataElt<F>> linkarray,
                            DataObjectFieldMarker<F> linkobjectid1,
                            DataObjectFieldMarker<F> linkobjectid2)

adds a dependency array on the GANNT chart

Parameters:

linkarray - the list of link objects

linkobjectid1 - first id of object (of type E) of the dependency

linkobjectid2 - second id of object (of type E) of the dependency

setColorField

public void setColorField(DataObjectFieldMarker<E> colorfield)

sets the attribute to be used

Parameters:

colorfield - the attribute of the object to be used as background for the task (tasks can be displayed with a color for the task and also a dot)

setDotMarkField

public void setDotMarkField(DataObjectFieldMarker<E> dotmarkfield)

sets the attribute to be used for dot mark field (tasks can be displayed with a color for the task and also a dot)

Parameters:

dotmarkfield - the attribute of the object to be used as color for dots on the task

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