Module com.flexganttfx.view
Package com.flexganttfx.view.graphics
Class GraphicsBase<R extends Row<?,?,?>>
java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.flexganttfx.view.util.FlexGanttFXControl
com.flexganttfx.view.graphics.GraphicsBase<R>
- Type Parameters:
R
- the type of the rows shown by the graphics
- All Implemented Interfaces:
Styleable
,EventTarget
,Skinnable
- Direct Known Subclasses:
ListViewGraphics
,SingleRowGraphics
,SplitPaneGraphics
,VBoxGraphics
public abstract class GraphicsBase<R extends Row<?,?,?>> extends FlexGanttFXControl
The graphics view control is responsible for the rendering of activities and
system layers, the editing of activities, the event notifications, the hit
detection, system layer management, and for context menu support.
Background layers are drawn "behind" activities, foreground layers are drawn "in front of" activities. Each one of these lists are already pre-populated but can be changed by the application. For more information on the available system layers, please refer to their individual documentation.
System layers can be turned on and off directly via the API of
Rendering
The graphics view uses the canvas API of JavaFX. This is due to the complex nature of a Gantt chart and due to the large data volumes often observed in Gantt charts. Directly rendering large quantities of activities into a bitmap is much faster than constantly updating the scene graph and reapplying CSS styling. FlexGanttFX implements a pluggable renderer architecture where renderer instances can be mapped to activity types, very similar to the way Swing was doing it. The following code is an example of how to register a custom renderer for a given "Flight" activity type. Please note that the graphics view is capable of displaying activities in three different layouts, hence the layout type must also be passed to the method.
setActivityRenderer(Flight.class, GanttLayout.class, new FlightRenderer());
System Layers
Activities are not the only thing that need to be rendered. There are also the current time ("now"), grid lines, inner lines, agenda / chart lines, etc... All of these things are rendered by so-called system layers (seeSystemLayer
). The graphics view manages two lists of these layers.
One list for background layers (getBackgroundSystemLayers()
) and one
list for foreground layers (getForegroundSystemLayers()
).
Background layers are drawn "behind" activities, foreground layers are drawn "in front of" activities. Each one of these lists are already pre-populated but can be changed by the application. For more information on the available system layers, please refer to their individual documentation.
System layers can be turned on and off directly via the API of
GraphicsBase
. There is a boolean property for each layer that ships
with FlexGanttFX. The value of these properties can be set by calling the
methods that follow the pattern setShowXYZLayer
. System layers
that are controlled like this will appear and disappear with a fade in / fade
out animation, while calling SystemLayer.setVisible(boolean)
directly
will be without any animation.
Editing Customization
Two different callbacks are used to control the editing behaviour of activities. The first maps a mouse event / mouse location to anGraphicsBase.EditMode
and can be registered by calling
setEditModeCallback(Class, Class, Callback)
. The second callback is
used to determine whether a given editing mode / operation can be applied to
an activity at all. This callback is registered by calling
setActivityEditingCallback(Class, Callback)
. Most applications will
only need to work with the second callback and keep the defaults for the edit
mode locations (for example: right edge used to change end time, left edge
used to change start time).
Notifications / Events
Events of typeActivityEvent
are sent whenever the user performs a
change inside the graphics view. Applications that want to receive these
events can either call any one of the setOnActivityXYZEvent()
methods or by adding an event handler directly via
addEventHandler(ActionEvent.ACTIVITY_XYZ, ...)
. Events are fired
while the change is being performed and once it has been completed. For this
the ActivityEvent
class lists event types with the two different
endings CHANGING and CHANGED.
Filtering
The data displayed by the graphics control can be filtered in two ways: first by showing / hiding rows, second by showing / hiding activities. Row filtering is done by the parent GanttChart controls while activity filtering is done by the graphics control via an activity filter predicate:
setActivityFilter(Predicate<Activity> filter);
Finding / Lookup / Hitpoint Detection
The graphics view provides support for finding out information about a given position. Activities can be found by callinggetActivityBoundsAt(double, double)
or
getActivityRefAt(double, double)
. The time at an x-coordinate can be
looked up by calling getTimeAt(double)
. The opposite direction is
also available: a location can be found for a given time by calling
getLocation(Instant)
.
Context Menu
Context menus can be set on any control in JavaFX but due to the complexitiy of the graphics view it does make sense to provide additional built-in support. By callingsetContextMenuCallback(Callback)
a context menu
specific callback can be registered with the graphics control. This callback
will be invoked when the user triggers the context menu. A callback parameter
object (see GraphicsBase.ContextMenuParameter
) will be passed to the callback
already populated with the most important values that might be relevant for
building a context menu.- Since:
- 1.0
-
Property Summary
Properties inherited from class javafx.scene.control.Control
contextMenu, skin, tooltip
Properties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
Properties inherited from class javafx.scene.Parent
needsLayout
Properties inherited from class javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GraphicsBase.ContextMenuParameter<R extends Row<?,?,?>>
A callback parameter class used for displaying a context menu.static class
GraphicsBase.DragAndDropFeedback
An enumerator used to define how to visuzalize the dragged activity during a drag and drop operation.static class
GraphicsBase.DragAndDropInfo
The drag and drop info class aggregates the various pieces of information that the application might be interested in while a drag and drop operation is in progress.static class
GraphicsBase.EditingCallbackParameter
A callback parameter object used for determining if the proposedGraphicsBase.EditMode
is currently allowed or not.static class
GraphicsBase.EditMode
An enumeration of possible editing states that the graphics view can be in.static class
GraphicsBase.EditModeCallbackParameter
A callback parameter object used by the edit mode callback that provides information about the context for which the edit mode will be determined.static class
GraphicsBase.LassoSelectionBehaviour
An enumerator used to control the selection behaviour of the lasso.static class
GraphicsBase.RowControlsParameter<R extends Row<?,?,?>>
A callback parameter object used to provide context for the row controls factory.static class
GraphicsBase.RowEditingMode
An enumerator used to define how many rows can show their row editors at the same time.static class
GraphicsBase.RowEditorParameter<R extends Row<?,?,?>>
A callback parameter object used to provide context for the row editor factory.static class
GraphicsBase.RowHeader<R extends Row<?,?,?>>
A row header is a node that can be displayed to the left of each row inside the graphics area.static class
GraphicsBase.SelectionMode
An enumerator used to control the selection behaviour of the graphics view. -
Field Summary
Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
Constructor Summary
Constructors Constructor Description GraphicsBase()
Constructs a new graphics view and initializes the following: Virtual grid settings (1, 5, 10, 15, 30, 60 Minutes) Activity renderers for several of the default model classes. Edit mode callbacks for several of the default model classes. Activity editing callbacks. Background and foreground layers. Calendars (e. -
Method Summary
Modifier and Type Method Description ObjectProperty<Predicate<Activity>>
activityFilterProperty()
A property used to store a filter function, which determines if an activity will be rendered or not.BooleanProperty
animateRowEditorProperty()
BooleanProperty
autoGridEnabledProperty()
A property used to enable / disable the autogrid mode.BooleanProperty
autoMarkedTimeIntervalProperty()
Controls whether the marked time interval property of theEventline
will be automatically set when the user performs certain editing operations (e.g.ReadOnlyBooleanProperty
automaticRedrawProperty()
A property used to determine if the graphics will be redrawn whenever the data in any of the activity repository changes.DoubleProperty
canvasBufferProperty()
A canvas buffer size that is larger than zero increases the rendering performance of the Gantt chart substantially as fewer repaints of each row's canvas are needed.ObjectProperty<Callback<GraphicsBase.ContextMenuParameter<R>,ContextMenu>>
contextMenuCallbackProperty()
A property used to store a callback which is used for creating a context menu.BooleanProperty
debugModeProperty()
A property used to enable / disable the debug mode.ObjectProperty<GraphicsBase.DragAndDropFeedback>
dragAndDropFeedbackProperty()
ReadOnlyObjectProperty<GraphicsBase.DragAndDropInfo>
dragAndDropInfoProperty()
A property used to store the current drag and drop information.ObjectProperty<Callback<ActivityRef<?>,Image>>
dragImageProviderProperty()
void
drawLinks(String reason)
Performs a redraw of the displayed links and logs the given reason.ObjectProperty<Callback<GraphicsBase.DragAndDropInfo,Layer>>
dropLayerProviderProperty()
A property used to store a callback that will return the layer on which a dragged activity will be placed once the drop operation has finished.ReadOnlyObjectProperty<ActivityRef<?>>
editedActivityProperty()
ReadOnlyObjectProperty<GraphicsBase.EditMode>
editModeProperty()
A property used to store the currently active editing mode, e.g.BooleanProperty
enableRowResizingProperty()
Controls whether the view allows the user to interactively resize the row / change the row height.DoubleProperty
fadeInOutVisibilityChangesDurationProperty()
BooleanProperty
fadeInOutVisibilityChangesProperty()
DoubleProperty
fixedCellSizeProperty()
A property used to store a fixed cell size for controls that are based on the virtual flow control.ActivityBounds
getActivityBoundsAt(double x, double y)
Finds the activity bounds at the given location.<A extends Activity>
Callback<GraphicsBase.EditingCallbackParameter,Boolean>getActivityEditingCallback(Class<A> activityType)
Predicate<Activity>
getActivityFilter()
Returns the value ofactivityFilterProperty()
.ActivityRef<?>
getActivityRefAt(double x, double y)
Finds the activity reference at the given location.<A extends Activity>
ActivityRenderer<? extends A>getActivityRenderer(Class<? extends A> activityType, Class<? extends Layout> layoutType)
List<ActivityBounds>
getAllActivityBoundsAt(double x, double y)
Returns the bounds of all activities found at the given location.List<ActivityRef<?>>
getAllActivityRefsAt(double x, double y)
Returns the references to all activities found at the given location.List<ActivityRenderer<?>>
getAllActivityRenderers()
Returns a list of all currently registered activity renderers.List<CalendarActivity>
getAllCalendarActivitiesAt(double x, double y)
Finds all calendar activities at the given location.<SL extends SystemLayer<R>>
SLgetBackgroundSystemLayer(Class<SL> layerType)
ObservableList<SystemLayer<R>>
getBackgroundSystemLayers()
ObservableList<Calendar<? extends CalendarActivity>>
getCalendars()
Returns the list of calendars that are registered with the graphics view.double
getCanvasBuffer()
Gets the value of the property canvasBuffer.static List<CssMetaData<? extends Styleable,?>>
getClassCssMetaData()
Callback<GraphicsBase.ContextMenuParameter<R>,ContextMenu>
getContextMenuCallback()
Returns the value ofcontextMenuCallbackProperty()
.List<CssMetaData<? extends Styleable,?>>
getControlCssMetaData()
GraphicsBase.DragAndDropFeedback
getDragAndDropFeedback()
Gets the value of the property dragAndDropFeedback.GraphicsBase.DragAndDropInfo
getDragAndDropInfo()
Returns the value ofdragAndDropInfoProperty()
.Callback<ActivityRef<?>,Image>
getDragImageProvider()
Gets the value of the property dragImageProvider.Callback<GraphicsBase.DragAndDropInfo,Layer>
getDropLayerProvider()
Returns the value ofdropLayerProviderProperty()
.Instant
getEarliestTimeUsed()
Calculates and returns the earliest time used by all rows in the model.ActivityRef<?>
getEditedActivity()
Gets the value of the property editedActivity.GraphicsBase.EditMode
getEditMode()
Returns the value ofeditModeProperty()
.Callback<GraphicsBase.EditModeCallbackParameter,GraphicsBase.EditMode>
getEditModeCallback(Class<? extends MutableActivity> activityType, Class<? extends Layout> layoutType)
double
getFadeInOutVisibilityChangesDuration()
Gets the value of the property fadeInOutVisibilityChangesDuration.double
getFixedCellSize()
Returns the value offixedCellSizeProperty()
.<SL extends SystemLayer<R>>
SLgetForegroundSystemLayer(Class<SL> layerType)
ObservableList<SystemLayer<R>>
getForegroundSystemLayers()
Paint
getGridLineColor1()
Gets the value of the property gridLineColor1.Paint
getGridLineColor2()
Gets the value of the property gridLineColor2.Paint
getGridLineColor3()
Gets the value of the property gridLineColor3.long
getHighlightDelay()
Returns the value ofhighlightDelayProperty()
.ObservableSet<ActivityRef<?>>
getHighlightedActivities()
Returns a set that is used to store the currently highighted activities.ObservableSet<Row<?,?,?>>
getHighlightedRows()
Returns a set that is used to store the currently highlighted rows.ActivityRef<?>
getHoverActivity()
Gets the value of the property hoverActivity.Layout
getHoverLayout()
Gets the value of the property hoverLayout.R
getHoverRow()
Gets the value of the property hoverRow.Paint
getInnerLinesColor()
Gets the value of the property innerLinesColor.GraphicsBase.LassoSelectionBehaviour
getLassoSelectionBehaviour()
Returns the value of thelassoSelectionBehaviourProperty()
.Instant
getLatestTimeUsed()
Calculates and returns the latest time used by all rows in the model.ObservableList<Layer>
getLayers()
Returns the list that is used to store all layers of the model.Layout
getLayoutAt(double y)
Finds the layout that is being used at the given y-coordinate.<AL extends ActivityLink<?>>
LinkRenderer<AL>getLinkRenderer(Class<AL> clazz)
Returns a renderer for the given activity link type.IntervalTree<ActivityLink>
getLinks()
Returns the interval tree that is used to store all activity links of the model.LocalTime
getLocalTimeAt(double y)
Returns the local time at the given location.double
getLocation(Instant time)
Returns the x coordinate for the given time.int
getMaxGridLevel()
Returns the value ofmaxGridLevelProperty()
.EventHandler<ActivityEvent>
getOnActivityChange()
Gets the value of the property onActivityChange.EventHandler<ActivityEvent>
getOnActivityChangeFinished()
Gets the value of the property onActivityChangeFinished.EventHandler<ActivityEvent>
getOnActivityChangeOngoing()
Gets the value of the property onActivityChangeOngoing.EventHandler<ActivityEvent>
getOnActivityChangeStarted()
Gets the value of the property onActivityChangeStarted.EventHandler<ActivityEvent>
getOnActivityChartHighValueChangeFinished()
Gets the value of the property onActivityChartHighValueChangeFinished.EventHandler<ActivityEvent>
getOnActivityChartHighValueChangeOngoing()
Gets the value of the property onActivityChartHighValueChangeOngoing.EventHandler<ActivityEvent>
getOnActivityChartHighValueChangeStarted()
Gets the value of the property onActivityChartHighValueChangeStarted.EventHandler<ActivityEvent>
getOnActivityChartLowValueChangeFinished()
Gets the value of the property onActivityChartLowValueChangeFinished.EventHandler<ActivityEvent>
getOnActivityChartLowValueChangeOngoing()
Gets the value of the property onActivityChartLowValueChangeOngoing.EventHandler<ActivityEvent>
getOnActivityChartLowValueChangeStarted()
Gets the value of the property onActivityChartLowValueChangeStarted.EventHandler<ActivityEvent>
getOnActivityChartValueChangeFinished()
Gets the value of the property onActivityChartValueChangeFinished.EventHandler<ActivityEvent>
getOnActivityChartValueChangeOngoing()
Gets the value of the property onActivityChartValueChangeOngoing.EventHandler<ActivityEvent>
getOnActivityChartValueChangeStarted()
Gets the value of the property onActivityChartValueChangeStarted.EventHandler<ActivityEvent>
getOnActivityDeleted()
Gets the value of the property onActivityDeleted.EventHandler<ActivityEvent>
getOnActivityDragDone()
Gets the value of the property onActivityDragDone.EventHandler<ActivityEvent>
getOnActivityDragFinished()
Gets the value of the property onActivityDragFinished.EventHandler<ActivityEvent>
getOnActivityDragOngoing()
Gets the value of the property onActivityDragOngoing.EventHandler<ActivityEvent>
getOnActivityDragStarted()
Gets the value of the property onActivityDragStarted.EventHandler<ActivityEvent>
getOnActivityEndTimeChangeFinished()
Gets the value of the property onActivityEndTimeChangeFinished.EventHandler<ActivityEvent>
getOnActivityEndTimeChangeOngoing()
Gets the value of the property onActivityEndTimeChangeOngoing.EventHandler<ActivityEvent>
getOnActivityEndTimeChangeStarted()
Gets the value of the property onActivityEndTimeChangeStarted.EventHandler<ActivityEvent>
getOnActivityHorizontalDragFinished()
Gets the value of the property onActivityHorizontalDragFinished.EventHandler<ActivityEvent>
getOnActivityHorizontalDragOngoing()
Gets the value of the property onActivityHorizontalDragOngoing.EventHandler<ActivityEvent>
getOnActivityHorizontalDragStarted()
Gets the value of the property onActivityHorizontalDragStarted.EventHandler<ActivityEvent>
getOnActivityPercentageChangeFinished()
Gets the value of the property onActivityPercentageChangeFinished.EventHandler<ActivityEvent>
getOnActivityPercentageChangeOngoing()
Gets the value of the property onActivityPercentageChangeOngoing.EventHandler<ActivityEvent>
getOnActivityPercentageChangeStarted()
Gets the value of the property onActivityPercentageChangeStarted.EventHandler<ActivityEvent>
getOnActivityStartTimeChangeFinished()
Gets the value of the property onActivityStartTimeChangeFinished.EventHandler<ActivityEvent>
getOnActivityStartTimeChangeOngoing()
Gets the value of the property onActivityStartTimeChangeOngoing.EventHandler<ActivityEvent>
getOnActivityStartTimeChangeStarted()
Gets the value of the property onActivityStartTimeChangeStarted.EventHandler<ActivityEvent>
getOnActivityVerticalDragDone()
Gets the value of the property onActivityVerticalDragDone.EventHandler<ActivityEvent>
getOnActivityVerticalDragFinished()
Gets the value of the property onActivityVerticalDragFinished.EventHandler<ActivityEvent>
getOnActivityVerticalDragOngoing()
Gets the value of the property onActivityVerticalDragOngoing.EventHandler<ActivityEvent>
getOnActivityVerticalDragStarted()
Gets the value of the property onActivityVerticalDragStarted.EventHandler<LassoEvent>
getOnLassoSelection()
Gets the value of the property onLassoSelection.EventHandler<LassoEvent>
getOnLassoSelectionFinished()
Gets the value of the property onLassoSelectionFinished.EventHandler<LassoEvent>
getOnLassoSelectionOngoing()
Gets the value of the property onLassoSelectionOngoing.EventHandler<LassoEvent>
getOnLassoSelectionStarted()
Gets the value of the property onLassoSelectionStarted.Node
getPlaceholder()
Gets the value of the property placeholder.ActivityRef<?>
getPressedActivity()
Gets the value of the property pressedActivity.R
getRowAt(double y)
Finds the row at the given y-coordinate.Callback<GraphicsBase.RowControlsParameter<R>,Node>
getRowControlsFactory()
Gets the value of the property rowControlsFactory.Callback<GraphicsBase.DragAndDropInfo,Boolean>
getRowDragAndDropCallback(Class<? extends Row> rowType)
Returns a callback that will be invoked when the user drags an activity over a row of the given type.GraphicsBase.RowEditingMode
getRowEditingMode()
Gets the value of the property rowEditingMode.Callback<GraphicsBase.RowEditorParameter<R>,Node>
getRowEditorFactory()
Gets the value of the property rowEditorFactory.Predicate
getRowFilter()
Returns the value ofrowFilterProperty()
.Callback<GraphicsBase<R>,GraphicsBase.RowHeader<R>>
getRowHeaderFactory()
Returns the value ofrowHeaderFactoryProperty()
.double
getRowHeadersWidth()
Gets the value of the property rowHeadersWidth.ObservableList<RowPane<R>>
getRowPanes()
ObservableList<R>
getRows()
Returns the list that is used to store all rows of the model.ObservableList<R>
getRowsEditing()
ObservableList<ActivityRef<?>>
getSelectedActivities()
Returns the list of currently selected activities.GraphicsBase.SelectionMode
getSelectionMode()
Returns the value ofselectionModeProperty()
.<SL extends SystemLayer<R>>
SLgetSystemLayer(Class<SL> layerType)
Instant
getTimeAt(double location)
Returns the time at the given location.Timeline
getTimeline()
Returns the value oftimelineProperty()
.Paint
getTimeNowColor()
Gets the value of the property timeNowColor.String
getUserAgentStylesheet()
VirtualGrid<?>
getVirtualGrid()
Gets the value of the property virtualGrid.ObservableList<VirtualGrid<?>>
getVirtualGrids()
Paint
getWeekendColor()
Gets the value of the property weekendColor.ReadOnlyBooleanProperty
gridEnabledProperty()
A convenience read-only property to check whether any kind of grid is active, either the automatic grid or a virtual grid.StyleableObjectProperty<Paint>
gridLineColor1Property()
StyleableObjectProperty<Paint>
gridLineColor2Property()
StyleableObjectProperty<Paint>
gridLineColor3Property()
LongProperty
highlightDelayProperty()
A property used to store the delay between two "blinks" of highlighted rows or activities.ReadOnlyBooleanProperty
highlightedProperty()
A read-only property used to control the highlighting effect.BooleanProperty
horizontalDragEnabledProperty()
Determines whether the user can perform a horizontal drag with a mouse drag.ReadOnlyObjectProperty<ActivityRef<?>>
hoverActivityProperty()
ReadOnlyObjectProperty<Layout>
hoverLayoutProperty()
ReadOnlyObjectProperty<R>
hoverRowProperty()
StyleableObjectProperty<Paint>
innerLinesColorProperty()
boolean
isAnimateRowEditor()
Gets the value of the property animateRowEditor.boolean
isAutoGridEnabled()
Returns the value ofautoGridEnabledProperty()
.boolean
isAutoMarkedTimeInterval()
Returns the value ofautoMarkedTimeIntervalProperty()
.boolean
isAutomaticRedraw()
Returns the value ofautomaticRedrawProperty()
.boolean
isDebugMode()
Returns the value ofdebugModeProperty()
.boolean
isEnableRowResizing()
Gets the value of the property enableRowResizing.boolean
isFadeInOutVisibilityChanges()
Gets the value of the property fadeInOutVisibilityChanges.boolean
isGridEnabled()
Returns the value ofgridEnabledProperty()
.boolean
isHighlighted()
Returns the value ofhighlightedProperty()
.boolean
isHorizontalDragEnabled()
Returns the value ofhorizontalDragEnabledProperty()
.boolean
isLassoActive()
Returns the value oflassoActiveProperty()
.boolean
isLassoEnabled()
Returns the value oflassoEnabledProperty()
.boolean
isLassoSnapsToGrid()
Returns the value oflassoSnapsToGridProperty()
.boolean
isSafeRendering()
Returns the value ofsafeRenderingProperty()
.boolean
isShowAgendaLinesLayer()
Gets the value of the property showAgendaLinesLayer.boolean
isShowCalendarLayer()
Gets the value of the property showCalendarLayer.boolean
isShowChartLinesLayer()
Gets the value of the property showChartLinesLayer.boolean
isShowDSTLineLayer()
Gets the value of the property showDSTLineLayer.boolean
isShowGridLineLayer()
Gets the value of the property showGridLineLayer.boolean
isShowHorizontalCursor()
Returns the value ofshowHorizontalCursorProperty()
.boolean
isShowHoverTimeIntervalLayer()
Gets the value of the property showHoverTimeIntervalLayer.boolean
isShowInnerLinesLayer()
Gets the value of the property showInnerLinesLayer.boolean
isShowLayoutLayer()
Gets the value of the property showLayoutLayer.boolean
isShowLinks()
Gets the value of the property showLinks.boolean
isShowMarkedTimeInterval()
Returns the value ofshowMarkedTimeIntervalProperty()
.boolean
isShowNowLineLayer()
Gets the value of the property showNowLineLayer.boolean
isShowRowHeaders()
Gets the value of the property showRowHeaders.boolean
isShowRowLayer()
Gets the value of the property showRowLayer.boolean
isShowSelectedTimeIntervalsLayer()
Gets the value of the property showSelectedTimeIntervalsLayer.boolean
isShowVerticalCursor()
Returns the value ofshowVerticalCursorProperty()
.boolean
isShowZoneId()
Gets the value of the property showZoneId.boolean
isShowZoomTimeIntervalLayer()
Gets the value of the property showZoomTimeIntervalLayer.ReadOnlyBooleanProperty
lassoActiveProperty()
A boolean property used to indicate whether the lasso selection tool is currently in use or not.BooleanProperty
lassoEnabledProperty()
A property used to control whether the user can use the lasso for selecting multiple activities at once.ObjectProperty<GraphicsBase.LassoSelectionBehaviour>
lassoSelectionBehaviourProperty()
A property used to store the currently used lasso selection behaviour.BooleanProperty
lassoSnapsToGridProperty()
A boolean property used to indicate whether the lasso selection tool is using the currently active grid settings.IntegerProperty
maxGridLevelProperty()
A property used to store the number of grid levels that the user wants to see in the graphics view.void
moveLayerBackward(Layer layer)
Moves the given layer backward within the stack of layers.void
moveLayerForward(Layer layer)
Moves the given layer forward within the stack of layers.void
moveLayerToBack(Layer layer)
Moves the given layer to the back so that the activities located on it will be drawn first and all other activities on other layers will be drawn on top of them.void
moveLayerToFront(Layer layer)
Moves the given layer to the front so that the activities located on it will be drawn on top of all other activities.ObjectProperty<EventHandler<ActivityEvent>>
onActivityChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChangeProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartHighValueChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartHighValueChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartHighValueChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartLowValueChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartLowValueChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartLowValueChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartValueChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartValueChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityChartValueChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityDeletedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityDragDoneProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityDragFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityDragOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityDragStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityEndTimeChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityEndTimeChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityEndTimeChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityHorizontalDragFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityHorizontalDragOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityHorizontalDragStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityPercentageChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityPercentageChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityPercentageChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityStartTimeChangeFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityStartTimeChangeOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityStartTimeChangeStartedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityVerticalDragDoneProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityVerticalDragFinishedProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityVerticalDragOngoingProperty()
ObjectProperty<EventHandler<ActivityEvent>>
onActivityVerticalDragStartedProperty()
ObjectProperty<EventHandler<LassoEvent>>
onLassoSelectionFinishedProperty()
ObjectProperty<EventHandler<LassoEvent>>
onLassoSelectionOngoingProperty()
ObjectProperty<EventHandler<LassoEvent>>
onLassoSelectionProperty()
ObjectProperty<EventHandler<LassoEvent>>
onLassoSelectionStartedProperty()
ObjectProperty<Node>
placeholderProperty()
ReadOnlyObjectProperty<ActivityRef<?>>
pressedActivityProperty()
void
redraw()
Performs a redraw of the displayed activities.void
redraw(String reason)
Performs a redraw of the displayed activities and logs the given reason.void
redrawImmediately()
Forces an immediate redraw of all rows.ObjectProperty<Callback<GraphicsBase.RowControlsParameter<R>,Node>>
rowControlsFactoryProperty()
ObjectProperty<GraphicsBase.RowEditingMode>
rowEditingModeProperty()
ObjectProperty<Callback<GraphicsBase.RowEditorParameter<R>,Node>>
rowEditorFactoryProperty()
ObjectProperty<Predicate<R>>
rowFilterProperty()
A predicate used to filter the rows.ObjectProperty<Callback<GraphicsBase<R>,GraphicsBase.RowHeader<R>>>
rowHeaderFactoryProperty()
A property used to store a callback for creating a node that will be placed to the left of each row in the graphics view.DoubleProperty
rowHeadersWidthProperty()
Specifies the width of the so-called "row headers".ListProperty<R>
rowsProperty()
Returns the property used to store the list of rows.BooleanProperty
safeRenderingProperty()
Returns the property that specifies whether the various canvas API-based rendering parts inside this framework will always callGraphicsContext.save()
to save the current state of the context before changing its state (followed byGraphicsContext.restore()
to restore the old state).ObjectProperty<GraphicsBase.SelectionMode>
selectionModeProperty()
A property used to store the currently supported selection mode.void
setActivityEditingCallback(Class<? extends MutableActivity> activityType, Callback<GraphicsBase.EditingCallbackParameter,Boolean> callback)
Registers a callback used to determine if a given editing operation can be used for a given activity.void
setActivityFilter(Predicate<Activity> filter)
Sets the value ofactivityFilterProperty()
.<A extends Activity>
voidsetActivityRenderer(Class<? extends A> activityType, Class<? extends Layout> layoutType, ActivityRenderer<? extends A> renderer)
Registers a renderer for the given activity and layout type.void
setAnimateRowEditor(boolean animate)
Sets the value of the property animateRowEditor.void
setAutoGridEnabled(boolean auto)
Sets the value ofautoGridEnabledProperty()
.void
setAutoMarkedTimeInterval(boolean auto)
Sets the value ofautoMarkedTimeIntervalProperty()
.void
setAutomaticRedraw(boolean automatic)
Sets the value ofautomaticRedrawProperty()
.void
setCanvasBuffer(double canvasBuffer)
Sets the value of the property canvasBuffer.void
setContextMenuCallback(Callback<GraphicsBase.ContextMenuParameter<R>,ContextMenu> callback)
Sets the value ofcontextMenuCallbackProperty()
.void
setDebugMode(boolean debug)
Sets the value ofdebugModeProperty()
.void
setDragAndDropFeedback(GraphicsBase.DragAndDropFeedback feedback)
Sets the value of the property dragAndDropFeedback.void
setDragImageProvider(Callback<ActivityRef<?>,Image> provider)
Sets the value of the property dragImageProvider.void
setDropLayerProvider(Callback<GraphicsBase.DragAndDropInfo,Layer> provider)
Sets the value ofdropLayerProviderProperty()
.void
setEditModeCallback(Class<? extends MutableActivity> activityType, Class<? extends Layout> layoutType, Callback<GraphicsBase.EditModeCallbackParameter,GraphicsBase.EditMode> callback)
void
setEnableRowResizing(boolean enableRowResizing)
Sets the value of the property enableRowResizing.void
setFadeInOutVisibilityChanges(boolean show)
Sets the value of the property fadeInOutVisibilityChanges.void
setFadeInOutVisibilityChangesDuration(double duration)
Sets the value of the property fadeInOutVisibilityChangesDuration.void
setFixedCellSize(double size)
Sets the value offixedCellSizeProperty()
.void
setGridLineColor1(Paint color)
Sets the value of the property gridLineColor1.void
setGridLineColor2(Paint color)
Sets the value of the property gridLineColor2.void
setGridLineColor3(Paint color)
Sets the value of the property gridLineColor3.void
setHighlightDelay(long delay)
Sets the value ofhighlightDelayProperty()
.void
setHorizontalDragEnabled(boolean enabled)
Sets the value ofhorizontalDragEnabledProperty()
.void
setInnerLinesColor(Paint color)
Sets the value of the property innerLinesColor.void
setLassoEnabled(boolean enabled)
Sets the value oflassoEnabledProperty()
.void
setLassoSelectionBehaviour(GraphicsBase.LassoSelectionBehaviour behaviour)
Sets the value oflassoSelectionBehaviourProperty()
.void
setLassoSnapsToGrid(boolean snaps)
Sets the value oflassoSnapsToGridProperty()
.void
setLinkRenderer(Class<? extends Activity> clazz, LinkRenderer<?> renderer)
Sets a custom link renderer for the given type of activity link.void
setMaxGridLevel(int max)
Sets the value ofmaxGridLevelProperty()
.void
setOnActivityChange(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChange.void
setOnActivityChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChangeFinished.void
setOnActivityChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChangeOngoing.void
setOnActivityChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChangeStarted.void
setOnActivityChartHighValueChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartHighValueChangeFinished.void
setOnActivityChartHighValueChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartHighValueChangeOngoing.void
setOnActivityChartHighValueChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartHighValueChangeStarted.void
setOnActivityChartLowValueChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartLowValueChangeFinished.void
setOnActivityChartLowValueChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartLowValueChangeOngoing.void
setOnActivityChartLowValueChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartLowValueChangeStarted.void
setOnActivityChartValueChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartValueChangeFinished.void
setOnActivityChartValueChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartValueChangeOngoing.void
setOnActivityChartValueChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityChartValueChangeStarted.void
setOnActivityDeleted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityDeleted.void
setOnActivityDragDone(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityDragDone.void
setOnActivityDragFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityDragFinished.void
setOnActivityDragOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityDragOngoing.void
setOnActivityDragStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityDragStarted.void
setOnActivityEndTimeChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityEndTimeChangeFinished.void
setOnActivityEndTimeChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityEndTimeChangeOngoing.void
setOnActivityEndTimeChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityEndTimeChangeStarted.void
setOnActivityHorizontalDragFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityHorizontalDragFinished.void
setOnActivityHorizontalDragOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityHorizontalDragOngoing.void
setOnActivityHorizontalDragStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityHorizontalDragStarted.void
setOnActivityPercentageChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityPercentageChangeFinished.void
setOnActivityPercentageChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityPercentageChangeOngoing.void
setOnActivityPercentageChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityPercentageChangeStarted.void
setOnActivityStartTimeChangeFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityStartTimeChangeFinished.void
setOnActivityStartTimeChangeOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityStartTimeChangeOngoing.void
setOnActivityStartTimeChangeStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityStartTimeChangeStarted.void
setOnActivityVerticalDragDone(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityVerticalDragDone.void
setOnActivityVerticalDragFinished(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityVerticalDragFinished.void
setOnActivityVerticalDragOngoing(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityVerticalDragOngoing.void
setOnActivityVerticalDragStarted(EventHandler<ActivityEvent> value)
Sets the value of the property onActivityVerticalDragStarted.void
setOnLassoSelection(EventHandler<LassoEvent> value)
Sets the value of the property onLassoSelection.void
setOnLassoSelectionFinished(EventHandler<LassoEvent> value)
Sets the value of the property onLassoSelectionFinished.void
setOnLassoSelectionOngoing(EventHandler<LassoEvent> value)
Sets the value of the property onLassoSelectionOngoing.void
setOnLassoSelectionStarted(EventHandler<LassoEvent> value)
Sets the value of the property onLassoSelectionStarted.void
setPlaceholder(Node node)
Sets the value of the property placeholder.void
setRowControlsFactory(Callback<GraphicsBase.RowControlsParameter<R>,Node> factory)
Sets the value of the property rowControlsFactory.void
setRowDragAndDropCallback(Class<? extends Row> rowType, Callback<GraphicsBase.DragAndDropInfo,Boolean> callback)
Specifies a callback that will be invoked when the user drags an activity over a row of the given type.void
setRowEditingMode(GraphicsBase.RowEditingMode mode)
Sets the value of the property rowEditingMode.void
setRowEditorFactory(Callback<GraphicsBase.RowEditorParameter<R>,Node> factory)
Sets the value of the property rowEditorFactory.void
setRowFilter(Predicate<R> predicate)
Sets the value ofrowFilterProperty()
.void
setRowHeaderFactory(Callback<GraphicsBase<R>,GraphicsBase.RowHeader<R>> factory)
Sets the value ofrowHeaderFactoryProperty()
.void
setRowHeadersWidth(double rowHeadersWidth)
Sets the value of the property rowHeadersWidth.void
setRows(ObservableList<R> rows)
Sets the value of therowsProperty()
.void
setSafeRendering(boolean safe)
Sets the value ofsafeRenderingProperty()
.void
setSelectionMode(GraphicsBase.SelectionMode mode)
Sets the value ofselectionModeProperty()
.void
setShowAgendaLinesLayer(boolean show)
Sets the value of the property showAgendaLinesLayer.void
setShowCalendarLayer(boolean show)
Sets the value of the property showCalendarLayer.void
setShowChartLinesLayer(boolean show)
Sets the value of the property showChartLinesLayer.void
setShowDSTLineLayer(boolean show)
Sets the value of the property showDSTLineLayer.void
setShowGridLineLayer(boolean show)
Sets the value of the property showGridLineLayer.void
setShowHorizontalCursor(boolean show)
Sets the value ofshowHorizontalCursorProperty()
.void
setShowHoverTimeIntervalLayer(boolean show)
Sets the value of the property showHoverTimeIntervalLayer.void
setShowInnerLinesLayer(boolean show)
Sets the value of the property showInnerLinesLayer.void
setShowLayoutLayer(boolean show)
Sets the value of the property showLayoutLayer.void
setShowLinks(boolean showLinks)
Sets the value of the property showLinks.void
setShowMarkedTimeInterval(boolean show)
Sets the value ofshowMarkedTimeIntervalProperty()
.void
setShowNowLineLayer(boolean show)
Sets the value of the property showNowLineLayer.void
setShowRowHeaders(boolean showRowHeaders)
Sets the value of the property showRowHeaders.void
setShowRowLayer(boolean show)
Sets the value of the property showRowLayer.void
setShowSelectedTimeIntervalsLayer(boolean show)
Sets the value of the property showSelectedTimeIntervalsLayer.void
setShowVerticalCursor(boolean show)
Sets the value ofshowVerticalCursorProperty()
.void
setShowZoneId(boolean show)
Sets the value of the property showZoneId.void
setShowZoomTimeIntervalLayer(boolean show)
Sets the value of the property showZoomTimeIntervalLayer.void
setTimeline(Timeline timeline)
Sets the value oftimelineProperty()
.void
setTimeNowColor(Paint color)
Sets the value of the property timeNowColor.void
setVirtualGrid(VirtualGrid<?> grid)
Sets the value of the property virtualGrid.void
setWeekendColor(Paint color)
Sets the value of the property weekendColor.BooleanProperty
showAgendaLinesLayerProperty()
void
showAllActivities()
Makes theTimeline
show a time range starting with the earliest time used and ending with the latest time used by all currently loaded rows.BooleanProperty
showCalendarLayerProperty()
BooleanProperty
showChartLinesLayerProperty()
BooleanProperty
showDSTLineLayerProperty()
void
showEarliestActivities()
Makes theTimeline
start with the earliest time used by the currently loaded rows.BooleanProperty
showGridLineLayerProperty()
BooleanProperty
showHorizontalCursorProperty()
A property used to control wether a horizontal cursor line will be shown by the graphics view.BooleanProperty
showHoverTimeIntervalLayerProperty()
BooleanProperty
showInnerLinesLayerProperty()
void
showLatestActivities()
Makes theTimeline
show the latest time used by the currently loaded rows.BooleanProperty
showLayoutLayerProperty()
BooleanProperty
showLinksProperty()
Controls whether theLinksCanvas
will be visible and links will be drawn.BooleanProperty
showMarkedTimeIntervalProperty()
A property used to control whether vertical lines will be shown for a marked time interval (e.g.BooleanProperty
showNowLineLayerProperty()
BooleanProperty
showRowHeadersProperty()
Determines if the row headers will be shown to the user or not.BooleanProperty
showRowLayerProperty()
BooleanProperty
showSelectedTimeIntervalsLayerProperty()
BooleanProperty
showVerticalCursorProperty()
A property used to control whether a vertical cursor line will be shown by the graphics view.BooleanProperty
showZoneIdProperty()
BooleanProperty
showZoomTimeIntervalLayerProperty()
void
startRowEditing(R row)
void
stopRowEditing()
void
stopRowEditing(R row)
ObjectProperty<Timeline>
timelineProperty()
A property used to store a reference to the timeline control above the graphics.StyleableObjectProperty<Paint>
timeNowColorProperty()
ObjectProperty<VirtualGrid<?>>
virtualGridProperty()
StyleableObjectProperty<Paint>
weekendColorProperty()
Methods inherited from class com.flexganttfx.view.util.FlexGanttFXControl
getUserAgentStylesheet
Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
rowFilter
A predicate used to filter the rows.- See Also:
getRowFilter()
,setRowFilter(Predicate)
-
activityFilter
A property used to store a filter function, which determines if an activity will be rendered or not. An activity will be drawn if the function returns "true".- Since:
- 1.6
- See Also:
getActivityFilter()
,setActivityFilter(Predicate)
-
lassoEnabled
A property used to control whether the user can use the lasso for selecting multiple activities at once.- Since:
- 1.6
- See Also:
isLassoEnabled()
,setLassoEnabled(boolean)
-
automaticRedraw
A property used to determine if the graphics will be redrawn whenever the data in any of the activity repository changes. The default value is true. Applications can use this property to disable the redrawing when they know that they have to add a lot of activities but do not want the chart to perform a lot of redraws. The graphics will be redrawn right away when the value of this property changes from true to false or vice versa.- Since:
- 1.5
- See Also:
isAutomaticRedraw()
,setAutomaticRedraw(boolean)
-
canvasBuffer
A canvas buffer size that is larger than zero increases the rendering performance of the Gantt chart substantially as fewer repaints of each row's canvas are needed.- See Also:
getCanvasBuffer()
,setCanvasBuffer(double)
-
lassoActive
A boolean property used to indicate whether the lasso selection tool is currently in use or not.- Since:
- 1.0
- See Also:
isLassoActive()
-
lassoSnapsToGrid
A boolean property used to indicate whether the lasso selection tool is using the currently active grid settings.- Since:
- 1.1
- See Also:
isLassoSnapsToGrid()
,setLassoSnapsToGrid(boolean)
-
rows
Returns the property used to store the list of rows.- Since:
- 1.6
- See Also:
getRows()
,setRows(ObservableList)
-
timeline
A property used to store a reference to the timeline control above the graphics.- Since:
- 1.0
- See Also:
getTimeline()
,setTimeline(Timeline)
-
fixedCellSize
A property used to store a fixed cell size for controls that are based on the virtual flow control. This value is not used by all subclasses of this class. Using a fixed cell size can result in a performance gain.- Since:
- 1.0
- See Also:
getFixedCellSize()
,setFixedCellSize(double)
-
onActivityDeleted
-
onActivityChange
-
onActivityChangeStarted
-
onActivityChangeOngoing
-
onActivityChangeFinished
-
onActivityDragStarted
-
onActivityDragOngoing
-
onActivityDragFinished
-
onActivityDragDone
-
onActivityChartValueChangeStarted
-
onActivityChartValueChangeOngoing
-
onActivityChartValueChangeFinished
-
onActivityChartHighValueChangeStarted
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartHighValueChangeStartedProperty -
onActivityChartHighValueChangeOngoing
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartHighValueChangeOngoingProperty -
onActivityChartHighValueChangeFinished
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartHighValueChangeFinishedProperty -
onActivityChartLowValueChangeStarted
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartLowValueChangeStartedProperty -
onActivityChartLowValueChangeOngoing
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartLowValueChangeOngoingProperty -
onActivityChartLowValueChangeFinished
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartLowValueChangeFinishedProperty -
onActivityHorizontalDragStarted
-
onActivityHorizontalDragOngoing
-
onActivityHorizontalDragFinished
-
onActivityVerticalDragStarted
-
onActivityVerticalDragOngoing
-
onActivityVerticalDragFinished
-
onActivityVerticalDragDone
-
onActivityEndTimeChangeStarted
-
onActivityEndTimeChangeOngoing
-
onActivityEndTimeChangeFinished
-
onActivityPercentageChangeStarted
-
onActivityPercentageChangeOngoing
-
onActivityPercentageChangeFinished
-
onActivityStartTimeChangeStarted
-
onActivityStartTimeChangeOngoing
-
onActivityStartTimeChangeFinished
-
onLassoSelection
-
onLassoSelectionStarted
-
onLassoSelectionOngoing
-
onLassoSelectionFinished
-
editMode
A property used to store the currently active editing mode, e.g. "changing start time", "changing end time", "dragging horizontally", "dragging vertically", etc...
The property is read-only as it can not be set from the outside. It is being updated when the user moves the mouse cursor on top of an activity. The edit mode depends on the location of the cursor (left or right edge, center). SeesetActivityEditingCallback(Class, Callback)
for mapping mouse events to editing operations.- Since:
- 1.0
- See Also:
getEditMode()
-
highlightDelay
A property used to store the delay between two "blinks" of highlighted rows or activities.- Since:
- 1.0
- See Also:
getHighlightDelay()
,setHighlightDelay(long)
-
highlighted
A read-only property used to control the highlighting effect. The value of this property gets frequently toggled between true and false so that is triggers a redraw of the graphics and a blink effect.- Since:
- 1.0
- See Also:
isHighlighted()
-
contextMenuCallback
public final ObjectProperty<Callback<GraphicsBase.ContextMenuParameter<R extends Row<?,?,?>>,ContextMenu>> contextMenuCallbackPropertyA property used to store a callback which is used for creating a context menu. Context menus can also be used by simply callingControl.setContextMenu(ContextMenu)
but using this callback saves you from collecting all the information and objects that can be found at the location of the context menu trigger event.- Since:
- 1.0
- See Also:
getContextMenuCallback()
,setContextMenuCallback(Callback)
-
autoMarkedTimeInterval
Controls whether the marked time interval property of theEventline
will be automatically set when the user performs certain editing operations (e.g. move an activity horizontally). The default is "true". -
maxGridLevel
A property used to store the number of grid levels that the user wants to see in the graphics view. The value of this property must be between 1 and 5. The grid level depends on the number of scales shown by the dateline (seeDateline.getScaleResolutions()
). If the dateline is currently showing two scales (e.g. days and weeks) then the graphics view and theGridLinesLayer
can also display two different grid lines, for example a light gray one for days and a dark gray one for weeks.- Since:
- 1.0
- See Also:
getMaxGridLevel()
,setMaxGridLevel(int)
-
showVerticalCursor
A property used to control whether a vertical cursor line will be shown by the graphics view. The line will always follow the location of the mouse cursor.- Since:
- 1.0
- See Also:
isShowVerticalCursor()
,setShowVerticalCursor(boolean)
-
showHorizontalCursor
A property used to control wether a horizontal cursor line will be shown by the graphics view. The line will always follow the location of the mouse cursor.- Since:
- 1.0
- See Also:
isShowHorizontalCursor()
,setShowHorizontalCursor(boolean)
-
showMarkedTimeInterval
A property used to control whether vertical lines will be shown for a marked time interval (e.g. while dragging the marked interval will display the new location of the dragged activity).- Since:
- 1.1
- See Also:
isShowMarkedTimeInterval()
,setShowMarkedTimeInterval(boolean)
-
debugMode
A property used to enable / disable the debug mode. The debug mode will cause the object bounds of activities to be rendered in the graphics view and also the bounds of the lasso selection tool. Other information might get added in the future.- Since:
- 1.0
- See Also:
isDebugMode()
,setDebugMode(boolean)
-
autoGridEnabled
A property used to enable / disable the autogrid mode. The autogrid mode will cause activities to snap to times based on the currently shown granularity of the dateline. If the dateline is showing "days" then the activities will snap to the beginning and / or end of a day. If the dateline is showing hours then the activities will snap to full hours.- Since:
- 1.1
- See Also:
isAutoGridEnabled()
,setAutoGridEnabled(boolean)
-
gridEnabled
A convenience read-only property to check whether any kind of grid is active, either the automatic grid or a virtual grid.- Since:
- 1.2
- See Also:
isGridEnabled()
-
selectionMode
A property used to store the currently supported selection mode. The graphics view supports single, multiple, and none.- Since:
- 1.0
- See Also:
getSelectionMode()
,setSelectionMode(GraphicsBase.SelectionMode)
-
lassoSelectionBehaviour
A property used to store the currently used lasso selection behaviour. This value of this property controls when an activity is actually considered selected by the lasso: does it need to be completely inside the lasso bounds or is it enough when it gets touched by the lasso?- Since:
- 1.0
- See Also:
getLassoSelectionBehaviour()
,setLassoSelectionBehaviour(GraphicsBase.LassoSelectionBehaviour)
-
hoverActivity
- See Also:
getHoverActivity()
-
hoverRow
- See Also:
getHoverRow()
-
hoverLayout
- See Also:
getHoverLayout()
-
editedActivity
- See Also:
getEditedActivity()
-
pressedActivity
- See Also:
getPressedActivity()
-
virtualGrid
- See Also:
getVirtualGrid()
,setVirtualGrid(VirtualGrid)
-
placeholder
- See Also:
getPlaceholder()
,setPlaceholder(Node)
-
dragAndDropInfo
A property used to store the current drag and drop information. This object stores data relevant to the current drag and drop operation.- Since:
- 1.0
- See Also:
getDragAndDropInfo()
-
dragImageProvider
-
showAgendaLinesLayer
-
showCalendarLayer
-
showLayoutLayer
- See Also:
isShowLayoutLayer()
,setShowLayoutLayer(boolean)
-
showChartLinesLayer
-
showGridLineLayer
-
showHoverTimeIntervalLayer
-
showInnerLinesLayer
-
showNowLineLayer
- See Also:
isShowNowLineLayer()
,setShowNowLineLayer(boolean)
-
showDSTLineLayer
- See Also:
isShowDSTLineLayer()
,setShowDSTLineLayer(boolean)
-
showRowLayer
- See Also:
isShowRowLayer()
,setShowRowLayer(boolean)
-
showSelectedTimeIntervalsLayer
-
showZoomTimeIntervalLayer
-
showZoneId
- See Also:
isShowZoneId()
,setShowZoneId(boolean)
-
fadeInOutVisibilityChanges
-
fadeInOutVisibilityChangesDuration
-
showLinks
Controls whether theLinksCanvas
will be visible and links will be drawn.- See Also:
isShowLinks()
,setShowLinks(boolean)
-
dragAndDropFeedback
-
rowControlsFactory
public final ObjectProperty<Callback<GraphicsBase.RowControlsParameter<R extends Row<?,?,?>>,Node>> rowControlsFactoryProperty -
enableRowResizing
Controls whether the view allows the user to interactively resize the row / change the row height.- Since:
- 11.12.0
- See Also:
isEnableRowResizing()
,setEnableRowResizing(boolean)
-
rowHeaderFactory
public final ObjectProperty<Callback<GraphicsBase<R extends Row<?,?,?>>,GraphicsBase.RowHeader<R extends Row<?,?,?>>>> rowHeaderFactoryPropertyA property used to store a callback for creating a node that will be placed to the left of each row in the graphics view.- Since:
- 11.11.0
- See Also:
getRowHeaderFactory()
,setRowHeaderFactory(Callback)
-
showRowHeaders
Determines if the row headers will be shown to the user or not.- Since:
- 11.11.0
- See Also:
isShowRowHeaders()
,setShowRowHeaders(boolean)
-
rowHeadersWidth
Specifies the width of the so-called "row headers". These are custom nodes that can be placed in front of every row inside the graphics area. For proper layout the width of all row headers has to be the same.- Since:
- 11.11.0
- See Also:
getRowHeadersWidth()
,setRowHeadersWidth(double)
-
rowEditorFactory
public final ObjectProperty<Callback<GraphicsBase.RowEditorParameter<R extends Row<?,?,?>>,Node>> rowEditorFactoryProperty -
rowEditingMode
-
animateRowEditor
- See Also:
isAnimateRowEditor()
,setAnimateRowEditor(boolean)
-
dropLayerProvider
public final ObjectProperty<Callback<GraphicsBase.DragAndDropInfo,Layer>> dropLayerProviderPropertyA property used to store a callback that will return the layer on which a dragged activity will be placed once the drop operation has finished. The default provider returns the layer on which the activity is currently shown.- Since:
- 1.2
- See Also:
getDropLayerProvider()
,setDropLayerProvider(Callback)
-
horizontalDragEnabled
Determines whether the user can perform a horizontal drag with a mouse drag.- Since:
- 1.3
- See Also:
isHorizontalDragEnabled()
,setHorizontalDragEnabled(boolean)
-
safeRendering
Returns the property that specifies whether the various canvas API-based rendering parts inside this framework will always callGraphicsContext.save()
to save the current state of the context before changing its state (followed byGraphicsContext.restore()
to restore the old state).Using save / restore will ensure that the pluggable system layers and activity renderers will not have any side effects on each other. Setting this property to true has an impact on performance. The default value of this property is false.
Example
The following code shows how the property is used within the framework.GraphicsContext gc = canvas.getGraphicsContext2D(); if (graphics.isSafeRendering()) { gc.save(); } gc.setTransform(...); gc.strokeLine(...); if (graphics.isSafeRendering()) { gc.restore(); }
- See Also:
isSafeRendering()
,setSafeRendering(boolean)
-
gridLineColor1
- See Also:
getGridLineColor1()
,setGridLineColor1(Paint)
-
gridLineColor2
- See Also:
getGridLineColor2()
,setGridLineColor2(Paint)
-
gridLineColor3
- See Also:
getGridLineColor3()
,setGridLineColor3(Paint)
-
weekendColor
- See Also:
getWeekendColor()
,setWeekendColor(Paint)
-
timeNowColor
- See Also:
getTimeNowColor()
,setTimeNowColor(Paint)
-
innerLinesColor
- See Also:
getInnerLinesColor()
,setInnerLinesColor(Paint)
-
-
Constructor Details
-
GraphicsBase
public GraphicsBase()Constructs a new graphics view and initializes the following:- Virtual grid settings (1, 5, 10, 15, 30, 60 Minutes)
- Activity renderers for several of the default model classes.
- Edit mode callbacks for several of the default model classes.
- Activity editing callbacks.
- Background and foreground layers.
- Calendars (e. g. weekend calendar).
- Since:
- 1.0
-
-
Method Details
-
getUserAgentStylesheet
- Overrides:
getUserAgentStylesheet
in classRegion
-
rowFilterProperty
A predicate used to filter the rows.- See Also:
getRowFilter()
,setRowFilter(Predicate)
-
setRowFilter
Sets the value ofrowFilterProperty()
.- Parameters:
predicate
- the filter predicate
-
getRowFilter
Returns the value ofrowFilterProperty()
.- Returns:
- the filter predicate
-
activityFilterProperty
A property used to store a filter function, which determines if an activity will be rendered or not. An activity will be drawn if the function returns "true".- Since:
- 1.6
- See Also:
getActivityFilter()
,setActivityFilter(Predicate)
-
getActivityFilter
Returns the value ofactivityFilterProperty()
.- Returns:
- the predicate / the filter function for activities
- Since:
- 1.6
-
setActivityFilter
Sets the value ofactivityFilterProperty()
.- Parameters:
filter
- the filter function- Since:
- 1.6
-
lassoEnabledProperty
A property used to control whether the user can use the lasso for selecting multiple activities at once.- Since:
- 1.6
- See Also:
isLassoEnabled()
,setLassoEnabled(boolean)
-
setLassoEnabled
public final void setLassoEnabled(boolean enabled)Sets the value oflassoEnabledProperty()
.- Parameters:
enabled
- if true the lasso will be usable by the user- Since:
- 1.6
-
isLassoEnabled
public final boolean isLassoEnabled()Returns the value oflassoEnabledProperty()
.- Returns:
- true if the user can use the lasso
- Since:
- 1.6
-
automaticRedrawProperty
A property used to determine if the graphics will be redrawn whenever the data in any of the activity repository changes. The default value is true. Applications can use this property to disable the redrawing when they know that they have to add a lot of activities but do not want the chart to perform a lot of redraws. The graphics will be redrawn right away when the value of this property changes from true to false or vice versa.- Since:
- 1.5
- See Also:
isAutomaticRedraw()
,setAutomaticRedraw(boolean)
-
isAutomaticRedraw
public final boolean isAutomaticRedraw()Returns the value ofautomaticRedrawProperty()
.- Returns:
- true if automatic redrawing will be performed (default)
- Since:
- 1.5
-
setAutomaticRedraw
public final void setAutomaticRedraw(boolean automatic)Sets the value ofautomaticRedrawProperty()
.- Parameters:
automatic
- if true then the graphics redraw after every repository change event- Since:
- 1.5
-
getCanvasBuffer
public final double getCanvasBuffer()Gets the value of the property canvasBuffer.- Property description:
- A canvas buffer size that is larger than zero increases the rendering performance of the Gantt chart substantially as fewer repaints of each row's canvas are needed.
-
canvasBufferProperty
A canvas buffer size that is larger than zero increases the rendering performance of the Gantt chart substantially as fewer repaints of each row's canvas are needed.- See Also:
getCanvasBuffer()
,setCanvasBuffer(double)
-
setCanvasBuffer
public final void setCanvasBuffer(double canvasBuffer)Sets the value of the property canvasBuffer.- Property description:
- A canvas buffer size that is larger than zero increases the rendering performance of the Gantt chart substantially as fewer repaints of each row's canvas are needed.
-
lassoActiveProperty
A boolean property used to indicate whether the lasso selection tool is currently in use or not.- Since:
- 1.0
- See Also:
isLassoActive()
-
isLassoActive
public final boolean isLassoActive()Returns the value oflassoActiveProperty()
.- Returns:
- true if the user is currently performing a lasso selection operation.
- Since:
- 1.0
-
lassoSnapsToGridProperty
A boolean property used to indicate whether the lasso selection tool is using the currently active grid settings.- Since:
- 1.1
- See Also:
isLassoSnapsToGrid()
,setLassoSnapsToGrid(boolean)
-
isLassoSnapsToGrid
public final boolean isLassoSnapsToGrid()Returns the value oflassoSnapsToGridProperty()
.- Returns:
- true if the lasso is obeying the current virtual grid settings
- Since:
- 1.1
-
setLassoSnapsToGrid
public final void setLassoSnapsToGrid(boolean snaps)Sets the value oflassoSnapsToGridProperty()
.- Parameters:
snaps
- if true the lasso will obey the grid- Since:
- 1.1
-
getLinks
Returns the interval tree that is used to store all activity links of the model.- Returns:
- a list of activity links
- Since:
- 1.0
-
getLayers
Returns the list that is used to store all layers of the model.- Returns:
- a list of layers
- Since:
- 1.0
-
rowsProperty
Returns the property used to store the list of rows.- Since:
- 1.6
- See Also:
getRows()
,setRows(ObservableList)
-
setRows
Sets the value of therowsProperty()
.- Parameters:
rows
- the new rows to display- Since:
- 1.6
-
getRows
Returns the list that is used to store all rows of the model.- Returns:
- a list of rows
- Since:
- 1.6
-
timelineProperty
A property used to store a reference to the timeline control above the graphics.- Since:
- 1.0
- See Also:
getTimeline()
,setTimeline(Timeline)
-
setTimeline
Sets the value oftimelineProperty()
.- Parameters:
timeline
- the timeline control above the graphics- Since:
- 1.0
-
getTimeline
Returns the value oftimelineProperty()
.- Returns:
- the timeline control above the graphics
- Since:
- 1.0
-
fixedCellSizeProperty
A property used to store a fixed cell size for controls that are based on the virtual flow control. This value is not used by all subclasses of this class. Using a fixed cell size can result in a performance gain.- Since:
- 1.0
- See Also:
getFixedCellSize()
,setFixedCellSize(double)
-
getFixedCellSize
public final double getFixedCellSize()Returns the value offixedCellSizeProperty()
.- Returns:
- the fixed cell size (default is -1)
- Since:
- 1.0
-
setFixedCellSize
public final void setFixedCellSize(double size)Sets the value offixedCellSizeProperty()
.- Parameters:
size
- the fixed cell size, -1 to disable fixed cell size- Since:
- 1.0
-
getLocation
Returns the x coordinate for the given time.- Parameters:
time
- the time for which to lookup a coordinate- Returns:
- the x coordinate for the given time
- Since:
- 1.0
- See Also:
getTimeAt(double)
,TimelineModel.calculateLocationForTime(Instant)
-
getTimeAt
Returns the time at the given location.- Parameters:
location
- the x-coordinate for which to retrieve the time- Returns:
- the time at the given location
- Since:
- 1.0
-
getLocalTimeAt
Returns the local time at the given location. This method will only return a valid value if theAgendaLayout
is being used at the given location (in graphics view coordinate space).- Parameters:
y
- the y-coordinate in the coordinate space of the graphics view- Returns:
- the local time at the given location or null if location not
managed by an
AgendaLayout
- Since:
- 1.0
-
getRowAt
Finds the row at the given y-coordinate.- Parameters:
y
- the y-coordinate in the coordinate space of the graphics view for which to return a row model object- Returns:
- the row model object at the given y-coordinate
- Since:
- 1.0
-
getLayoutAt
Finds the layout that is being used at the given y-coordinate.- Parameters:
y
- the y-coordinate in the coordinate space of the graphics view for which to return the layout- Returns:
- the layout used at the given location
- Since:
- 1.0
-
getActivityBoundsAt
Finds the activity bounds at the given location. Returns the bounds of the activity drawn last if several activities can be found at the given location.- Parameters:
x
- the x-coordinate in the coordinate space of the graphics viewy
- the y-coordinate in the coordinate space of the graphics view- Returns:
- the bounds of the activity found at the given location or null if no activity can be found
- Since:
- 1.0
-
getActivityRefAt
Finds the activity reference at the given location. Returns the reference of the activity drawn last if several activities can be found at the given location.- Parameters:
x
- the x-coordinate in the coordinate space of the graphics viewy
- the y-coordinate in the coordinate space of the graphics view- Returns:
- the reference of the activity found at the given location or null if no activity can be found
- Since:
- 1.0
-
getAllActivityBoundsAt
Returns the bounds of all activities found at the given location. Activities can be drawn on top of each other, hence several bounds can exist at the same location.- Parameters:
x
- the x-coordinate in the coordinate space of the graphics viewy
- the y-coordinate in the coordinate space of the graphics view- Returns:
- the bounds of the activities found at the given location or null if no activities can be found
- Since:
- 1.0
-
getAllActivityRefsAt
Returns the references to all activities found at the given location. Activities can be drawn on top of each other, hence several references can exist at the same location.- Parameters:
x
- the x-coordinate in the coordinate space of the graphics viewy
- the y-coordinate in the coordinate space of the graphics view- Returns:
- the references of all activities found at the given location or null if no activities can be found
- Since:
- 1.0
-
getAllCalendarActivitiesAt
Finds all calendar activities at the given location.- Parameters:
x
- the x-coordinate in the coordinate space of the graphics viewy
- the y-coordinate in the coordinate space of the graphics view- Returns:
- all calendar activities at the given location
- Since:
- 1.1
-
moveLayerToFront
Moves the given layer to the front so that the activities located on it will be drawn on top of all other activities.- Parameters:
layer
- the layer to move- Since:
- 1.0
- See Also:
getLayers()
-
moveLayerToBack
Moves the given layer to the back so that the activities located on it will be drawn first and all other activities on other layers will be drawn on top of them.- Parameters:
layer
- the layer to move- Since:
- 1.0
- See Also:
getLayers()
-
moveLayerForward
Moves the given layer forward within the stack of layers.- Parameters:
layer
- the layer to move- Since:
- 1.0
- See Also:
getLayers()
-
moveLayerBackward
Moves the given layer backward within the stack of layers.- Parameters:
layer
- the layer to move- Since:
- 1.0
- See Also:
getLayers()
-
onActivityDeletedProperty
-
setOnActivityDeleted
Sets the value of the property onActivityDeleted.- Property description:
-
getOnActivityDeleted
Gets the value of the property onActivityDeleted.- Property description:
-
onActivityChangeProperty
-
setOnActivityChange
Sets the value of the property onActivityChange.- Property description:
-
getOnActivityChange
Gets the value of the property onActivityChange.- Property description:
-
onActivityChangeStartedProperty
-
setOnActivityChangeStarted
Sets the value of the property onActivityChangeStarted.- Property description:
-
getOnActivityChangeStarted
Gets the value of the property onActivityChangeStarted.- Property description:
-
onActivityChangeOngoingProperty
-
setOnActivityChangeOngoing
Sets the value of the property onActivityChangeOngoing.- Property description:
-
getOnActivityChangeOngoing
Gets the value of the property onActivityChangeOngoing.- Property description:
-
onActivityChangeFinishedProperty
-
setOnActivityChangeFinished
Sets the value of the property onActivityChangeFinished.- Property description:
-
getOnActivityChangeFinished
Gets the value of the property onActivityChangeFinished.- Property description:
-
onActivityDragStartedProperty
-
setOnActivityDragStarted
Sets the value of the property onActivityDragStarted.- Property description:
-
getOnActivityDragStarted
Gets the value of the property onActivityDragStarted.- Property description:
-
onActivityDragOngoingProperty
-
setOnActivityDragOngoing
Sets the value of the property onActivityDragOngoing.- Property description:
-
getOnActivityDragOngoing
Gets the value of the property onActivityDragOngoing.- Property description:
-
onActivityDragFinishedProperty
-
setOnActivityDragFinished
Sets the value of the property onActivityDragFinished.- Property description:
-
getOnActivityDragFinished
Gets the value of the property onActivityDragFinished.- Property description:
-
onActivityDragDoneProperty
-
setOnActivityDragDone
Sets the value of the property onActivityDragDone.- Property description:
-
getOnActivityDragDone
Gets the value of the property onActivityDragDone.- Property description:
-
onActivityChartValueChangeStartedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartValueChangeStartedProperty() -
setOnActivityChartValueChangeStarted
Sets the value of the property onActivityChartValueChangeStarted.- Property description:
-
getOnActivityChartValueChangeStarted
Gets the value of the property onActivityChartValueChangeStarted.- Property description:
-
onActivityChartValueChangeOngoingProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartValueChangeOngoingProperty() -
setOnActivityChartValueChangeOngoing
Sets the value of the property onActivityChartValueChangeOngoing.- Property description:
-
getOnActivityChartValueChangeOngoing
Gets the value of the property onActivityChartValueChangeOngoing.- Property description:
-
onActivityChartValueChangeFinishedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartValueChangeFinishedProperty() -
setOnActivityChartValueChangeFinished
Sets the value of the property onActivityChartValueChangeFinished.- Property description:
-
getOnActivityChartValueChangeFinished
Gets the value of the property onActivityChartValueChangeFinished.- Property description:
-
onActivityChartHighValueChangeStartedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartHighValueChangeStartedProperty() -
setOnActivityChartHighValueChangeStarted
Sets the value of the property onActivityChartHighValueChangeStarted.- Property description:
-
getOnActivityChartHighValueChangeStarted
Gets the value of the property onActivityChartHighValueChangeStarted.- Property description:
-
onActivityChartHighValueChangeOngoingProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartHighValueChangeOngoingProperty() -
setOnActivityChartHighValueChangeOngoing
Sets the value of the property onActivityChartHighValueChangeOngoing.- Property description:
-
getOnActivityChartHighValueChangeOngoing
Gets the value of the property onActivityChartHighValueChangeOngoing.- Property description:
-
onActivityChartHighValueChangeFinishedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartHighValueChangeFinishedProperty() -
setOnActivityChartHighValueChangeFinished
Sets the value of the property onActivityChartHighValueChangeFinished.- Property description:
-
getOnActivityChartHighValueChangeFinished
Gets the value of the property onActivityChartHighValueChangeFinished.- Property description:
-
onActivityChartLowValueChangeStartedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartLowValueChangeStartedProperty() -
setOnActivityChartLowValueChangeStarted
Sets the value of the property onActivityChartLowValueChangeStarted.- Property description:
-
getOnActivityChartLowValueChangeStarted
Gets the value of the property onActivityChartLowValueChangeStarted.- Property description:
-
onActivityChartLowValueChangeOngoingProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartLowValueChangeOngoingProperty() -
setOnActivityChartLowValueChangeOngoing
Sets the value of the property onActivityChartLowValueChangeOngoing.- Property description:
-
getOnActivityChartLowValueChangeOngoing
Gets the value of the property onActivityChartLowValueChangeOngoing.- Property description:
-
onActivityChartLowValueChangeFinishedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityChartLowValueChangeFinishedProperty() -
setOnActivityChartLowValueChangeFinished
Sets the value of the property onActivityChartLowValueChangeFinished.- Property description:
-
getOnActivityChartLowValueChangeFinished
Gets the value of the property onActivityChartLowValueChangeFinished.- Property description:
-
onActivityHorizontalDragStartedProperty
-
setOnActivityHorizontalDragStarted
Sets the value of the property onActivityHorizontalDragStarted.- Property description:
-
getOnActivityHorizontalDragStarted
Gets the value of the property onActivityHorizontalDragStarted.- Property description:
-
onActivityHorizontalDragOngoingProperty
-
setOnActivityHorizontalDragOngoing
Sets the value of the property onActivityHorizontalDragOngoing.- Property description:
-
getOnActivityHorizontalDragOngoing
Gets the value of the property onActivityHorizontalDragOngoing.- Property description:
-
onActivityHorizontalDragFinishedProperty
-
setOnActivityHorizontalDragFinished
Sets the value of the property onActivityHorizontalDragFinished.- Property description:
-
getOnActivityHorizontalDragFinished
Gets the value of the property onActivityHorizontalDragFinished.- Property description:
-
onActivityVerticalDragStartedProperty
-
setOnActivityVerticalDragStarted
Sets the value of the property onActivityVerticalDragStarted.- Property description:
-
getOnActivityVerticalDragStarted
Gets the value of the property onActivityVerticalDragStarted.- Property description:
-
onActivityVerticalDragOngoingProperty
-
setOnActivityVerticalDragOngoing
Sets the value of the property onActivityVerticalDragOngoing.- Property description:
-
getOnActivityVerticalDragOngoing
Gets the value of the property onActivityVerticalDragOngoing.- Property description:
-
onActivityVerticalDragFinishedProperty
-
setOnActivityVerticalDragFinished
Sets the value of the property onActivityVerticalDragFinished.- Property description:
-
getOnActivityVerticalDragFinished
Gets the value of the property onActivityVerticalDragFinished.- Property description:
-
onActivityVerticalDragDoneProperty
-
setOnActivityVerticalDragDone
Sets the value of the property onActivityVerticalDragDone.- Property description:
-
getOnActivityVerticalDragDone
Gets the value of the property onActivityVerticalDragDone.- Property description:
-
onActivityEndTimeChangeStartedProperty
-
setOnActivityEndTimeChangeStarted
Sets the value of the property onActivityEndTimeChangeStarted.- Property description:
-
getOnActivityEndTimeChangeStarted
Gets the value of the property onActivityEndTimeChangeStarted.- Property description:
-
onActivityEndTimeChangeOngoingProperty
-
setOnActivityEndTimeChangeOngoing
Sets the value of the property onActivityEndTimeChangeOngoing.- Property description:
-
getOnActivityEndTimeChangeOngoing
Gets the value of the property onActivityEndTimeChangeOngoing.- Property description:
-
onActivityEndTimeChangeFinishedProperty
-
setOnActivityEndTimeChangeFinished
Sets the value of the property onActivityEndTimeChangeFinished.- Property description:
-
getOnActivityEndTimeChangeFinished
Gets the value of the property onActivityEndTimeChangeFinished.- Property description:
-
onActivityPercentageChangeStartedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityPercentageChangeStartedProperty() -
setOnActivityPercentageChangeStarted
Sets the value of the property onActivityPercentageChangeStarted.- Property description:
-
getOnActivityPercentageChangeStarted
Gets the value of the property onActivityPercentageChangeStarted.- Property description:
-
onActivityPercentageChangeOngoingProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityPercentageChangeOngoingProperty() -
setOnActivityPercentageChangeOngoing
Sets the value of the property onActivityPercentageChangeOngoing.- Property description:
-
getOnActivityPercentageChangeOngoing
Gets the value of the property onActivityPercentageChangeOngoing.- Property description:
-
onActivityPercentageChangeFinishedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityPercentageChangeFinishedProperty() -
setOnActivityPercentageChangeFinished
Sets the value of the property onActivityPercentageChangeFinished.- Property description:
-
getOnActivityPercentageChangeFinished
Gets the value of the property onActivityPercentageChangeFinished.- Property description:
-
onActivityStartTimeChangeStartedProperty
-
setOnActivityStartTimeChangeStarted
Sets the value of the property onActivityStartTimeChangeStarted.- Property description:
-
getOnActivityStartTimeChangeStarted
Gets the value of the property onActivityStartTimeChangeStarted.- Property description:
-
onActivityStartTimeChangeOngoingProperty
-
setOnActivityStartTimeChangeOngoing
Sets the value of the property onActivityStartTimeChangeOngoing.- Property description:
-
getOnActivityStartTimeChangeOngoing
Gets the value of the property onActivityStartTimeChangeOngoing.- Property description:
-
onActivityStartTimeChangeFinishedProperty
public final ObjectProperty<EventHandler<ActivityEvent>> onActivityStartTimeChangeFinishedProperty() -
setOnActivityStartTimeChangeFinished
Sets the value of the property onActivityStartTimeChangeFinished.- Property description:
-
getOnActivityStartTimeChangeFinished
Gets the value of the property onActivityStartTimeChangeFinished.- Property description:
-
onLassoSelectionProperty
-
setOnLassoSelection
Sets the value of the property onLassoSelection.- Property description:
-
getOnLassoSelection
Gets the value of the property onLassoSelection.- Property description:
-
onLassoSelectionStartedProperty
-
setOnLassoSelectionStarted
Sets the value of the property onLassoSelectionStarted.- Property description:
-
getOnLassoSelectionStarted
Gets the value of the property onLassoSelectionStarted.- Property description:
-
onLassoSelectionOngoingProperty
-
setOnLassoSelectionOngoing
Sets the value of the property onLassoSelectionOngoing.- Property description:
-
getOnLassoSelectionOngoing
Gets the value of the property onLassoSelectionOngoing.- Property description:
-
onLassoSelectionFinishedProperty
-
setOnLassoSelectionFinished
Sets the value of the property onLassoSelectionFinished.- Property description:
-
getOnLassoSelectionFinished
Gets the value of the property onLassoSelectionFinished.- Property description:
-
editModeProperty
A property used to store the currently active editing mode, e.g. "changing start time", "changing end time", "dragging horizontally", "dragging vertically", etc...
The property is read-only as it can not be set from the outside. It is being updated when the user moves the mouse cursor on top of an activity. The edit mode depends on the location of the cursor (left or right edge, center). SeesetActivityEditingCallback(Class, Callback)
for mapping mouse events to editing operations.- Since:
- 1.0
- See Also:
getEditMode()
-
getEditMode
Returns the value ofeditModeProperty()
.- Returns:
- the currently active edit mode
- Since:
- 1.0
-
getHighlightedRows
Returns a set that is used to store the currently highlighted rows. A row added to this set will start blinking and draw the attention of the user to it.- Returns:
- the set of highlighted rows
- Since:
- 1.0
- See Also:
setHighlightDelay(long)
-
getHighlightedActivities
Returns a set that is used to store the currently highighted activities. An activity added to this set will start blinking and draw the attention of the user to it.- Returns:
- the set of highlighted activities
- Since:
- 1.0
- See Also:
setHighlightDelay(long)
-
highlightDelayProperty
A property used to store the delay between two "blinks" of highlighted rows or activities.- Since:
- 1.0
- See Also:
getHighlightDelay()
,setHighlightDelay(long)
-
setHighlightDelay
public final void setHighlightDelay(long delay)Sets the value ofhighlightDelayProperty()
.- Parameters:
delay
- the highlight delay in milliseconds- Since:
- 1.0
-
getHighlightDelay
public final long getHighlightDelay()Returns the value ofhighlightDelayProperty()
.- Returns:
- the highlight delay in milliseconds
- Since:
- 1.0
-
highlightedProperty
A read-only property used to control the highlighting effect. The value of this property gets frequently toggled between true and false so that is triggers a redraw of the graphics and a blink effect.- Since:
- 1.0
- See Also:
isHighlighted()
-
isHighlighted
public final boolean isHighlighted()Returns the value ofhighlightedProperty()
.- Returns:
- a flag value used to toggle the highlighting effect
- Since:
- 1.0
-
contextMenuCallbackProperty
public final ObjectProperty<Callback<GraphicsBase.ContextMenuParameter<R>,ContextMenu>> contextMenuCallbackProperty()A property used to store a callback which is used for creating a context menu. Context menus can also be used by simply callingControl.setContextMenu(ContextMenu)
but using this callback saves you from collecting all the information and objects that can be found at the location of the context menu trigger event.- Since:
- 1.0
- See Also:
getContextMenuCallback()
,setContextMenuCallback(Callback)
-
setContextMenuCallback
public final void setContextMenuCallback(Callback<GraphicsBase.ContextMenuParameter<R>,ContextMenu> callback)Sets the value ofcontextMenuCallbackProperty()
.- Parameters:
callback
- a callback for creating a parameterized context menu- Since:
- 1.0
-
getContextMenuCallback
Returns the value ofcontextMenuCallbackProperty()
.- Returns:
- the callback for creating a parameterized context menu
- Since:
- 1.0
-
autoMarkedTimeIntervalProperty
Controls whether the marked time interval property of theEventline
will be automatically set when the user performs certain editing operations (e.g. move an activity horizontally). The default is "true". -
isAutoMarkedTimeInterval
public final boolean isAutoMarkedTimeInterval()Returns the value ofautoMarkedTimeIntervalProperty()
.- Returns:
- true if the marked time interval gets updated automatically
-
setAutoMarkedTimeInterval
public final void setAutoMarkedTimeInterval(boolean auto)Sets the value ofautoMarkedTimeIntervalProperty()
.- Parameters:
auto
- if true the marked time interval will be updated automatically
-
maxGridLevelProperty
A property used to store the number of grid levels that the user wants to see in the graphics view. The value of this property must be between 1 and 5. The grid level depends on the number of scales shown by the dateline (seeDateline.getScaleResolutions()
). If the dateline is currently showing two scales (e.g. days and weeks) then the graphics view and theGridLinesLayer
can also display two different grid lines, for example a light gray one for days and a dark gray one for weeks.- Since:
- 1.0
- See Also:
getMaxGridLevel()
,setMaxGridLevel(int)
-
getMaxGridLevel
public final int getMaxGridLevel()Returns the value ofmaxGridLevelProperty()
.- Returns:
- the maximum number of grid levels
- Since:
- 1.0
-
setMaxGridLevel
public final void setMaxGridLevel(int max)Sets the value ofmaxGridLevelProperty()
.- Parameters:
max
- the maximum number of grid levels, a value between 1 and 5- Since:
- 1.0
-
showVerticalCursorProperty
A property used to control whether a vertical cursor line will be shown by the graphics view. The line will always follow the location of the mouse cursor.- Since:
- 1.0
- See Also:
isShowVerticalCursor()
,setShowVerticalCursor(boolean)
-
isShowVerticalCursor
public final boolean isShowVerticalCursor()Returns the value ofshowVerticalCursorProperty()
.- Returns:
- true if the cursor will be shown
- Since:
- 1.0
-
setShowVerticalCursor
public final void setShowVerticalCursor(boolean show)Sets the value ofshowVerticalCursorProperty()
.- Parameters:
show
- if true a vertical cursor line will be shown- Since:
- 1.0
-
showHorizontalCursorProperty
A property used to control wether a horizontal cursor line will be shown by the graphics view. The line will always follow the location of the mouse cursor.- Since:
- 1.0
- See Also:
isShowHorizontalCursor()
,setShowHorizontalCursor(boolean)
-
isShowHorizontalCursor
public final boolean isShowHorizontalCursor()Returns the value ofshowHorizontalCursorProperty()
.- Returns:
- true if the cursor will be shown
- Since:
- 1.0
-
setShowHorizontalCursor
public final void setShowHorizontalCursor(boolean show)Sets the value ofshowHorizontalCursorProperty()
.- Parameters:
show
- if true a horizontal cursor line will be shown- Since:
- 1.0
-
showMarkedTimeIntervalProperty
A property used to control whether vertical lines will be shown for a marked time interval (e.g. while dragging the marked interval will display the new location of the dragged activity).- Since:
- 1.1
- See Also:
isShowMarkedTimeInterval()
,setShowMarkedTimeInterval(boolean)
-
isShowMarkedTimeInterval
public final boolean isShowMarkedTimeInterval()Returns the value ofshowMarkedTimeIntervalProperty()
.- Returns:
- true if the marker lines will be shown
- Since:
- 1.1
- See Also:
Eventline.markedTimeIntervalProperty()
-
setShowMarkedTimeInterval
public final void setShowMarkedTimeInterval(boolean show)Sets the value ofshowMarkedTimeIntervalProperty()
.- Parameters:
show
- if true marker lines will be drawn for the currently marked time interval- Since:
- 1.1
- See Also:
Eventline.markedTimeIntervalProperty()
-
debugModeProperty
A property used to enable / disable the debug mode. The debug mode will cause the object bounds of activities to be rendered in the graphics view and also the bounds of the lasso selection tool. Other information might get added in the future.- Since:
- 1.0
- See Also:
isDebugMode()
,setDebugMode(boolean)
-
isDebugMode
public final boolean isDebugMode()Returns the value ofdebugModeProperty()
.- Returns:
- true if the debug mode is enabled
- Since:
- 1.0
-
setDebugMode
public final void setDebugMode(boolean debug)Sets the value ofdebugModeProperty()
.- Parameters:
debug
- if true the debug mode is enabled- Since:
- 1.0
-
autoGridEnabledProperty
A property used to enable / disable the autogrid mode. The autogrid mode will cause activities to snap to times based on the currently shown granularity of the dateline. If the dateline is showing "days" then the activities will snap to the beginning and / or end of a day. If the dateline is showing hours then the activities will snap to full hours.- Since:
- 1.1
- See Also:
isAutoGridEnabled()
,setAutoGridEnabled(boolean)
-
isAutoGridEnabled
public final boolean isAutoGridEnabled()Returns the value ofautoGridEnabledProperty()
.- Returns:
- true if the autogrid mode is enabled
- Since:
- 1.1
-
setAutoGridEnabled
public final void setAutoGridEnabled(boolean auto)Sets the value ofautoGridEnabledProperty()
.- Parameters:
auto
- if true the autogrid mode is enabled- Since:
- 1.1
-
gridEnabledProperty
A convenience read-only property to check whether any kind of grid is active, either the automatic grid or a virtual grid.- Since:
- 1.2
- See Also:
isGridEnabled()
-
isGridEnabled
public final boolean isGridEnabled()Returns the value ofgridEnabledProperty()
.- Returns:
- true if any kind of grid support is enabled
- Since:
- 1.2
-
selectionModeProperty
A property used to store the currently supported selection mode. The graphics view supports single, multiple, and none.- Since:
- 1.0
- See Also:
getSelectionMode()
,setSelectionMode(GraphicsBase.SelectionMode)
-
getSelectionMode
Returns the value ofselectionModeProperty()
.- Returns:
- the currently used selection mode (single, all, none)
- Since:
- 1.0
-
setSelectionMode
Sets the value ofselectionModeProperty()
.- Parameters:
mode
- the new selection mode- Since:
- 1.0
-
getSelectedActivities
Returns the list of currently selected activities.- Returns:
- the list of selected activities
- Since:
- 1.0
-
lassoSelectionBehaviourProperty
A property used to store the currently used lasso selection behaviour. This value of this property controls when an activity is actually considered selected by the lasso: does it need to be completely inside the lasso bounds or is it enough when it gets touched by the lasso?- Since:
- 1.0
- See Also:
getLassoSelectionBehaviour()
,setLassoSelectionBehaviour(GraphicsBase.LassoSelectionBehaviour)
-
setLassoSelectionBehaviour
Sets the value oflassoSelectionBehaviourProperty()
.- Parameters:
behaviour
- the lasso selection behaviour to use- Since:
- 1.0
-
getLassoSelectionBehaviour
Returns the value of thelassoSelectionBehaviourProperty()
.- Returns:
- the currently used lasso selection behaviour
- Since:
- 1.0
-
getCalendars
Returns the list of calendars that are registered with the graphics view. Calendars are used to render static information in the background of each row. One example are the days that are considered weekend days (e.g. saturday and sunday). They will be drawn with a gray background.- Returns:
- the calendars drawn by the graphics view
- Since:
- 1.0
- See Also:
CalendarLayer.setCalendarActivityRenderer(Class, com.flexganttfx.view.graphics.renderer.CalendarActivityRenderer)
-
showEarliestActivities
public final void showEarliestActivities()Makes theTimeline
start with the earliest time used by the currently loaded rows.- Since:
- 1.0
- See Also:
getEarliestTimeUsed()
,Timeline.showTime(Instant, boolean)
,ActivityRepository.getEarliestTimeUsed()
-
showLatestActivities
public final void showLatestActivities()Makes theTimeline
show the latest time used by the currently loaded rows.- Since:
- 1.0
- See Also:
getLatestTimeUsed()
,Timeline.showTime(Instant, boolean)
,ActivityRepository.getLatestTimeUsed()
-
showAllActivities
public final void showAllActivities()Makes theTimeline
show a time range starting with the earliest time used and ending with the latest time used by all currently loaded rows. -
getEarliestTimeUsed
Calculates and returns the earliest time used by all rows in the model.- Returns:
- the earliest time used by the graphics view
- Since:
- 1.0
- See Also:
Row.getEarliestTimeUsed()
,ActivityRepository.getEarliestTimeUsed()
-
getLatestTimeUsed
Calculates and returns the latest time used by all rows in the model.- Returns:
- the latest time used by the graphics view
- Since:
- 1.0
- See Also:
Row.getLatestTimeUsed()
,ActivityRepository.getLatestTimeUsed()
-
hoverActivityProperty
- See Also:
getHoverActivity()
-
getHoverActivity
Gets the value of the property hoverActivity.- Property description:
-
hoverRowProperty
- See Also:
getHoverRow()
-
getHoverRow
Gets the value of the property hoverRow.- Property description:
-
hoverLayoutProperty
- See Also:
getHoverLayout()
-
getHoverLayout
Gets the value of the property hoverLayout.- Property description:
-
editedActivityProperty
- See Also:
getEditedActivity()
-
getEditedActivity
Gets the value of the property editedActivity.- Property description:
-
pressedActivityProperty
- See Also:
getPressedActivity()
-
getPressedActivity
Gets the value of the property pressedActivity.- Property description:
-
virtualGridProperty
- See Also:
getVirtualGrid()
,setVirtualGrid(VirtualGrid)
-
getVirtualGrid
Gets the value of the property virtualGrid.- Property description:
-
setVirtualGrid
Sets the value of the property virtualGrid.- Property description:
-
getVirtualGrids
-
placeholderProperty
- See Also:
getPlaceholder()
,setPlaceholder(Node)
-
getPlaceholder
Gets the value of the property placeholder.- Property description:
-
setPlaceholder
Sets the value of the property placeholder.- Property description:
-
getRowPanes
-
redraw
public void redraw()Performs a redraw of the displayed activities. Also lays out the links shown by theLinksCanvas
. -
redraw
Performs a redraw of the displayed activities and logs the given reason. Also lays out the links shown by theLinksCanvas
. -
redrawImmediately
public void redrawImmediately()Forces an immediate redraw of all rows.- Since:
- 11.12.3
- See Also:
RowCanvas.draw()
-
drawLinks
Performs a redraw of the displayed links and logs the given reason. -
getAllActivityRenderers
Returns a list of all currently registered activity renderers.- Returns:
- all activity renderers
- Since:
- 8.9.0
-
setActivityRenderer
public final <A extends Activity> void setActivityRenderer(Class<? extends A> activityType, Class<? extends Layout> layoutType, ActivityRenderer<? extends A> renderer)Registers a renderer for the given activity and layout type. The renderer will be used to "draw" any activity of the given type when the activity is laid out via the given layout.- Type Parameters:
A
- the type of the activity- Parameters:
activityType
- the type of the activitylayoutType
- the type of the layoutrenderer
- the renderer instance
-
getActivityRenderer
public final <A extends Activity> ActivityRenderer<? extends A> getActivityRenderer(Class<? extends A> activityType, Class<? extends Layout> layoutType) -
setLinkRenderer
Sets a custom link renderer for the given type of activity link.- Parameters:
clazz
- the activity typerenderer
- the renderer
-
getLinkRenderer
Returns a renderer for the given activity link type.- Type Parameters:
AL
- the activity link type- Parameters:
clazz
- the activity link type- Returns:
- the link renderer
-
setActivityEditingCallback
public final void setActivityEditingCallback(Class<? extends MutableActivity> activityType, Callback<GraphicsBase.EditingCallbackParameter,Boolean> callback)Registers a callback used to determine if a given editing operation can be used for a given activity.- Parameters:
activityType
- the type of the activity for which to use the callbackcallback
- the callback- Since:
- 1.0
-
getActivityEditingCallback
public final <A extends Activity> Callback<GraphicsBase.EditingCallbackParameter,Boolean> getActivityEditingCallback(Class<A> activityType) -
setRowDragAndDropCallback
public final void setRowDragAndDropCallback(Class<? extends Row> rowType, Callback<GraphicsBase.DragAndDropInfo,Boolean> callback)Specifies a callback that will be invoked when the user drags an activity over a row of the given type. The callback implementation then determines if a drop would be accepted in the given row.- Parameters:
rowType
- the type of the row for which the callback gets registeredcallback
- the callback implementation- Since:
- 1.0
-
getRowDragAndDropCallback
public final Callback<GraphicsBase.DragAndDropInfo,Boolean> getRowDragAndDropCallback(Class<? extends Row> rowType)Returns a callback that will be invoked when the user drags an activity over a row of the given type. The callback implementation then determines if a drop would be accepted in the given row.- Parameters:
rowType
- the type of the row for which the callback gets registered- Returns:
- the callback implementation
- Since:
- 1.0
-
dragAndDropInfoProperty
A property used to store the current drag and drop information. This object stores data relevant to the current drag and drop operation.- Since:
- 1.0
- See Also:
getDragAndDropInfo()
-
getDragAndDropInfo
Returns the value ofdragAndDropInfoProperty()
.- Returns:
- the current drag and drop information
- Since:
- 1.0
-
dragImageProviderProperty
-
setDragImageProvider
Sets the value of the property dragImageProvider.- Property description:
-
getDragImageProvider
Gets the value of the property dragImageProvider.- Property description:
-
getBackgroundSystemLayer
-
getForegroundSystemLayer
-
getSystemLayer
-
getBackgroundSystemLayers
-
getForegroundSystemLayers
-
showAgendaLinesLayerProperty
-
setShowAgendaLinesLayer
public final void setShowAgendaLinesLayer(boolean show)Sets the value of the property showAgendaLinesLayer.- Property description:
-
isShowAgendaLinesLayer
public final boolean isShowAgendaLinesLayer()Gets the value of the property showAgendaLinesLayer.- Property description:
-
showCalendarLayerProperty
-
setShowCalendarLayer
public final void setShowCalendarLayer(boolean show)Sets the value of the property showCalendarLayer.- Property description:
-
isShowCalendarLayer
public final boolean isShowCalendarLayer()Gets the value of the property showCalendarLayer.- Property description:
-
showLayoutLayerProperty
- See Also:
isShowLayoutLayer()
,setShowLayoutLayer(boolean)
-
setShowLayoutLayer
public final void setShowLayoutLayer(boolean show)Sets the value of the property showLayoutLayer.- Property description:
-
isShowLayoutLayer
public final boolean isShowLayoutLayer()Gets the value of the property showLayoutLayer.- Property description:
-
showChartLinesLayerProperty
-
setShowChartLinesLayer
public final void setShowChartLinesLayer(boolean show)Sets the value of the property showChartLinesLayer.- Property description:
-
isShowChartLinesLayer
public final boolean isShowChartLinesLayer()Gets the value of the property showChartLinesLayer.- Property description:
-
showGridLineLayerProperty
-
setShowGridLineLayer
public final void setShowGridLineLayer(boolean show)Sets the value of the property showGridLineLayer.- Property description:
-
isShowGridLineLayer
public final boolean isShowGridLineLayer()Gets the value of the property showGridLineLayer.- Property description:
-
showHoverTimeIntervalLayerProperty
-
setShowHoverTimeIntervalLayer
public final void setShowHoverTimeIntervalLayer(boolean show)Sets the value of the property showHoverTimeIntervalLayer.- Property description:
-
isShowHoverTimeIntervalLayer
public final boolean isShowHoverTimeIntervalLayer()Gets the value of the property showHoverTimeIntervalLayer.- Property description:
-
showInnerLinesLayerProperty
-
setShowInnerLinesLayer
public final void setShowInnerLinesLayer(boolean show)Sets the value of the property showInnerLinesLayer.- Property description:
-
isShowInnerLinesLayer
public final boolean isShowInnerLinesLayer()Gets the value of the property showInnerLinesLayer.- Property description:
-
showNowLineLayerProperty
- See Also:
isShowNowLineLayer()
,setShowNowLineLayer(boolean)
-
setShowNowLineLayer
public final void setShowNowLineLayer(boolean show)Sets the value of the property showNowLineLayer.- Property description:
-
isShowNowLineLayer
public final boolean isShowNowLineLayer()Gets the value of the property showNowLineLayer.- Property description:
-
showDSTLineLayerProperty
- See Also:
isShowDSTLineLayer()
,setShowDSTLineLayer(boolean)
-
setShowDSTLineLayer
public final void setShowDSTLineLayer(boolean show)Sets the value of the property showDSTLineLayer.- Property description:
-
isShowDSTLineLayer
public final boolean isShowDSTLineLayer()Gets the value of the property showDSTLineLayer.- Property description:
-
showRowLayerProperty
- See Also:
isShowRowLayer()
,setShowRowLayer(boolean)
-
setShowRowLayer
public final void setShowRowLayer(boolean show)Sets the value of the property showRowLayer.- Property description:
-
isShowRowLayer
public final boolean isShowRowLayer()Gets the value of the property showRowLayer.- Property description:
-
showSelectedTimeIntervalsLayerProperty
-
setShowSelectedTimeIntervalsLayer
public final void setShowSelectedTimeIntervalsLayer(boolean show)Sets the value of the property showSelectedTimeIntervalsLayer.- Property description:
-
isShowSelectedTimeIntervalsLayer
public final boolean isShowSelectedTimeIntervalsLayer()Gets the value of the property showSelectedTimeIntervalsLayer.- Property description:
-
showZoomTimeIntervalLayerProperty
-
setShowZoomTimeIntervalLayer
public final void setShowZoomTimeIntervalLayer(boolean show)Sets the value of the property showZoomTimeIntervalLayer.- Property description:
-
isShowZoomTimeIntervalLayer
public final boolean isShowZoomTimeIntervalLayer()Gets the value of the property showZoomTimeIntervalLayer.- Property description:
-
showZoneIdProperty
- See Also:
isShowZoneId()
,setShowZoneId(boolean)
-
setShowZoneId
public final void setShowZoneId(boolean show)Sets the value of the property showZoneId.- Property description:
-
isShowZoneId
public final boolean isShowZoneId()Gets the value of the property showZoneId.- Property description:
-
fadeInOutVisibilityChangesProperty
-
isFadeInOutVisibilityChanges
public final boolean isFadeInOutVisibilityChanges()Gets the value of the property fadeInOutVisibilityChanges.- Property description:
-
setFadeInOutVisibilityChanges
public final void setFadeInOutVisibilityChanges(boolean show)Sets the value of the property fadeInOutVisibilityChanges.- Property description:
-
fadeInOutVisibilityChangesDurationProperty
-
getFadeInOutVisibilityChangesDuration
public final double getFadeInOutVisibilityChangesDuration()Gets the value of the property fadeInOutVisibilityChangesDuration.- Property description:
-
setFadeInOutVisibilityChangesDuration
public final void setFadeInOutVisibilityChangesDuration(double duration)Sets the value of the property fadeInOutVisibilityChangesDuration.- Property description:
-
isShowLinks
public final boolean isShowLinks()Gets the value of the property showLinks.- Property description:
- Controls whether the
LinksCanvas
will be visible and links will be drawn.
-
showLinksProperty
Controls whether theLinksCanvas
will be visible and links will be drawn.- See Also:
isShowLinks()
,setShowLinks(boolean)
-
setShowLinks
public final void setShowLinks(boolean showLinks)Sets the value of the property showLinks.- Property description:
- Controls whether the
LinksCanvas
will be visible and links will be drawn.
-
dragAndDropFeedbackProperty
-
setDragAndDropFeedback
Sets the value of the property dragAndDropFeedback.- Property description:
-
getDragAndDropFeedback
Gets the value of the property dragAndDropFeedback.- Property description:
-
rowControlsFactoryProperty
public final ObjectProperty<Callback<GraphicsBase.RowControlsParameter<R>,Node>> rowControlsFactoryProperty() -
setRowControlsFactory
public final void setRowControlsFactory(Callback<GraphicsBase.RowControlsParameter<R>,Node> factory)Sets the value of the property rowControlsFactory.- Property description:
-
getRowControlsFactory
Gets the value of the property rowControlsFactory.- Property description:
-
enableRowResizingProperty
Controls whether the view allows the user to interactively resize the row / change the row height.- Since:
- 11.12.0
- See Also:
isEnableRowResizing()
,setEnableRowResizing(boolean)
-
isEnableRowResizing
public final boolean isEnableRowResizing()Gets the value of the property enableRowResizing.- Property description:
- Controls whether the view allows the user to interactively resize the row / change the row height.
- Since:
- 11.12.0
-
setEnableRowResizing
public final void setEnableRowResizing(boolean enableRowResizing)Sets the value of the property enableRowResizing.- Property description:
- Controls whether the view allows the user to interactively resize the row / change the row height.
- Since:
- 11.12.0
-
rowHeaderFactoryProperty
public final ObjectProperty<Callback<GraphicsBase<R>,GraphicsBase.RowHeader<R>>> rowHeaderFactoryProperty()A property used to store a callback for creating a node that will be placed to the left of each row in the graphics view.- Since:
- 11.11.0
- See Also:
getRowHeaderFactory()
,setRowHeaderFactory(Callback)
-
setRowHeaderFactory
public final void setRowHeaderFactory(Callback<GraphicsBase<R>,GraphicsBase.RowHeader<R>> factory)Sets the value ofrowHeaderFactoryProperty()
.- Parameters:
factory
- the factory used for creating the row header nodes- Since:
- 11.11.0
-
getRowHeaderFactory
Returns the value ofrowHeaderFactoryProperty()
.- Returns:
- the row header nodes factory
- Since:
- 11.11.0
-
showRowHeadersProperty
Determines if the row headers will be shown to the user or not.- Since:
- 11.11.0
- See Also:
isShowRowHeaders()
,setShowRowHeaders(boolean)
-
isShowRowHeaders
public final boolean isShowRowHeaders()Gets the value of the property showRowHeaders.- Property description:
- Determines if the row headers will be shown to the user or not.
- Since:
- 11.11.0
-
setShowRowHeaders
public final void setShowRowHeaders(boolean showRowHeaders)Sets the value of the property showRowHeaders.- Property description:
- Determines if the row headers will be shown to the user or not.
- Since:
- 11.11.0
-
rowHeadersWidthProperty
Specifies the width of the so-called "row headers". These are custom nodes that can be placed in front of every row inside the graphics area. For proper layout the width of all row headers has to be the same.- Since:
- 11.11.0
- See Also:
getRowHeadersWidth()
,setRowHeadersWidth(double)
-
getRowHeadersWidth
public final double getRowHeadersWidth()Gets the value of the property rowHeadersWidth.- Property description:
- Specifies the width of the so-called "row headers". These are custom nodes that can be placed in front of every row inside the graphics area. For proper layout the width of all row headers has to be the same.
- Since:
- 11.11.0
-
setRowHeadersWidth
public final void setRowHeadersWidth(double rowHeadersWidth)Sets the value of the property rowHeadersWidth.- Property description:
- Specifies the width of the so-called "row headers". These are custom nodes that can be placed in front of every row inside the graphics area. For proper layout the width of all row headers has to be the same.
- Since:
- 11.11.0
-
rowEditorFactoryProperty
public final ObjectProperty<Callback<GraphicsBase.RowEditorParameter<R>,Node>> rowEditorFactoryProperty() -
setRowEditorFactory
Sets the value of the property rowEditorFactory.- Property description:
-
getRowEditorFactory
Gets the value of the property rowEditorFactory.- Property description:
-
rowEditingModeProperty
-
setRowEditingMode
Sets the value of the property rowEditingMode.- Property description:
-
getRowEditingMode
Gets the value of the property rowEditingMode.- Property description:
-
getRowsEditing
-
stopRowEditing
public final void stopRowEditing() -
stopRowEditing
-
startRowEditing
-
animateRowEditorProperty
- See Also:
isAnimateRowEditor()
,setAnimateRowEditor(boolean)
-
setAnimateRowEditor
public final void setAnimateRowEditor(boolean animate)Sets the value of the property animateRowEditor.- Property description:
-
isAnimateRowEditor
public final boolean isAnimateRowEditor()Gets the value of the property animateRowEditor.- Property description:
-
setEditModeCallback
public final void setEditModeCallback(Class<? extends MutableActivity> activityType, Class<? extends Layout> layoutType, Callback<GraphicsBase.EditModeCallbackParameter,GraphicsBase.EditMode> callback) -
getEditModeCallback
public final Callback<GraphicsBase.EditModeCallbackParameter,GraphicsBase.EditMode> getEditModeCallback(Class<? extends MutableActivity> activityType, Class<? extends Layout> layoutType) -
dropLayerProviderProperty
public final ObjectProperty<Callback<GraphicsBase.DragAndDropInfo,Layer>> dropLayerProviderProperty()A property used to store a callback that will return the layer on which a dragged activity will be placed once the drop operation has finished. The default provider returns the layer on which the activity is currently shown.- Since:
- 1.2
- See Also:
getDropLayerProvider()
,setDropLayerProvider(Callback)
-
getDropLayerProvider
Returns the value ofdropLayerProviderProperty()
.- Returns:
- the drop layer provider used for DnD operations
- Since:
- 1.2
-
setDropLayerProvider
Sets the value ofdropLayerProviderProperty()
.- Parameters:
provider
- the drop layer provider used for DnD operations- Since:
- 1.2
-
horizontalDragEnabledProperty
Determines whether the user can perform a horizontal drag with a mouse drag.- Since:
- 1.3
- See Also:
isHorizontalDragEnabled()
,setHorizontalDragEnabled(boolean)
-
setHorizontalDragEnabled
public final void setHorizontalDragEnabled(boolean enabled)Sets the value ofhorizontalDragEnabledProperty()
.- Parameters:
enabled
- if true the user can perform horizontal scrolling
-
isHorizontalDragEnabled
public final boolean isHorizontalDragEnabled()Returns the value ofhorizontalDragEnabledProperty()
.- Returns:
- true if the user can perform horizontal scrolling
-
safeRenderingProperty
Returns the property that specifies whether the various canvas API-based rendering parts inside this framework will always callGraphicsContext.save()
to save the current state of the context before changing its state (followed byGraphicsContext.restore()
to restore the old state).Using save / restore will ensure that the pluggable system layers and activity renderers will not have any side effects on each other. Setting this property to true has an impact on performance. The default value of this property is false.
Example
The following code shows how the property is used within the framework.GraphicsContext gc = canvas.getGraphicsContext2D(); if (graphics.isSafeRendering()) { gc.save(); } gc.setTransform(...); gc.strokeLine(...); if (graphics.isSafeRendering()) { gc.restore(); }
- See Also:
isSafeRendering()
,setSafeRendering(boolean)
-
setSafeRendering
public final void setSafeRendering(boolean safe)Sets the value ofsafeRenderingProperty()
.- Parameters:
safe
- if true the safe rendering mode will be used (the graphics context state will be saved before invoking renderers or drawing system layers).
-
isSafeRendering
public final boolean isSafeRendering()Returns the value ofsafeRenderingProperty()
.- Returns:
- "true" if the safe rendering mode will be used (the graphics context state will be saved before invoking renderers or drawing system layers).
-
gridLineColor1Property
- See Also:
getGridLineColor1()
,setGridLineColor1(Paint)
-
getGridLineColor1
Gets the value of the property gridLineColor1.- Property description:
-
setGridLineColor1
Sets the value of the property gridLineColor1.- Property description:
-
gridLineColor2Property
- See Also:
getGridLineColor2()
,setGridLineColor2(Paint)
-
getGridLineColor2
Gets the value of the property gridLineColor2.- Property description:
-
setGridLineColor2
Sets the value of the property gridLineColor2.- Property description:
-
gridLineColor3Property
- See Also:
getGridLineColor3()
,setGridLineColor3(Paint)
-
getGridLineColor3
Gets the value of the property gridLineColor3.- Property description:
-
setGridLineColor3
Sets the value of the property gridLineColor3.- Property description:
-
weekendColorProperty
- See Also:
getWeekendColor()
,setWeekendColor(Paint)
-
getWeekendColor
Gets the value of the property weekendColor.- Property description:
-
setWeekendColor
Sets the value of the property weekendColor.- Property description:
-
timeNowColorProperty
- See Also:
getTimeNowColor()
,setTimeNowColor(Paint)
-
getTimeNowColor
Gets the value of the property timeNowColor.- Property description:
-
setTimeNowColor
Sets the value of the property timeNowColor.- Property description:
-
innerLinesColorProperty
- See Also:
getInnerLinesColor()
,setInnerLinesColor(Paint)
-
getInnerLinesColor
Gets the value of the property innerLinesColor.- Property description:
-
setInnerLinesColor
Sets the value of the property innerLinesColor.- Property description:
-
getClassCssMetaData
-
getControlCssMetaData
- Overrides:
getControlCssMetaData
in classControl
-