com.chap.links.client

Class Timeline.Options

java.lang.Object

AbstractDrawOptions

com.chap.links.client.Timeline.Options

Enclosing class:

Timeline

public static class Timeline.Options
extends AbstractDrawOptions

Options for drawing the timeline. Create an instance via the method create, for example Timeline.Options options = Timeline.Options.create();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Timeline.Options.SCALE
static class	Timeline.Options.STYLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Timeline.Options() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static Timeline.Options	create() Create a Javascript object instance of Options()
void	setAnimate(boolean animate) Set animate to true (default) or false.
void	setAnimateZoom(boolean animateZoom) Set animating when zooming to true (default) or false.
void	setAxisOnTop(boolean axisOnTop) If set to true, the axis is shown on top.
void	setBoxAlign(java.lang.String alignment) Set alignment for items with style "box".
void	setCustomStackOrder(JavaScriptObject customStackOrder) Set the stack order for the timeline.
void	setDragAreaWidth(int dragAreaWidth) Set the width of the drag areas in pixels.
void	setEditable(boolean editable) If true (default), the events can be edited, created, deleted.
void	setEnd(java.util.Date end) Set the end date for the timeline
void	setEventMargin(int margin) Set the event margin for the events.
void	setEventMarginAxis(int margin) Set the minimal distance between the events and the axis.
void	setGroupMinHeight(int groupMinHeight) Set the minimum group height for the timeline in pixels.
void	setGroupsChangeable(boolean groupsChangeable) If true (default), items can be moved from one group to another.
void	setGroupsOnRight(boolean groupsOnRight) If set to true, the groups legend is shown at the right.
void	setGroupsWidth(int width) Set the width for the groups legend in pixels.
void	setGroupsWidth(java.lang.String width) Set the width for the groups legend in pixels or percentages.
void	setHeight(int height) Set the height for the timeline in pixels.
void	setHeight(java.lang.String height) Set the height for the Timeline in pixels or percentages.
void	setIntervalMax(long intervalMax) Deprecated.
void	setIntervalMin(long intervalMin) Deprecated.
void	setLocale(java.lang.String locale) Set the locale for the timeline.
void	setMax(java.util.Date max) Set a maximum Date for the visible range.
void	setMin(java.util.Date min) Set a minimum Date for the visible range.
void	setMinHeight(int minHeight) Set the minimum height for the timeline in pixels.
void	setMoveable(boolean moveable) If true (default), the timeline can be moved.
void	setScale(Timeline.Options.SCALE scale, double step) Set a custom scale.
void	setSelectable(boolean selectable) If true (default), the events on the timeline can be selected.
void	setShowButtonAdd(boolean show) If set to true (default), and the timeline is editable, an add button is shown in the navigation menu
void	setShowCurrentTime(boolean show) If set to true (default), a vertical line is shown at the current time
void	setShowCustomTime(boolean show) If set to true, the custom time bar is shown.
void	setShowMajorLabels(boolean showMajorLabels) By default, the timeline shows both minor and major date labels on the horizontal axis.
void	setShowMinorLabels(boolean showMinorLabels) By default, the timeline shows both minor and major date labels on the horizontal axis.
void	setShowNavigation(boolean show) If set to true, a navigation menu is shown, containing buttons to move and zoom the timeline.
void	setSnapEvents(boolean snapEvents) If true (default), the start and end of an event will be snapped nice integer values when moving or resizing the event.
void	setStackEvents(boolean stackEvents) If set to true, the events are stacked above each other to prevent overlapping events.
void	setStart(java.util.Date start) Set the start date for the timeline
void	setStyle(Timeline.Options.STYLE style) Set the style for the timeline.
void	setWidth(int width) Set the width for the timeline in pixels.
void	setWidth(java.lang.String width) Set the width for the timeline in pixels or percentages.
void	setZoomable(boolean zoomable) If true (default), the timeline can be zoomed.
void	setZoomMax(long zoomMax) Set a maximum zoom interval for the visible range in milliseconds.
void	setZoomMin(long zoomMin) Set a minimum zoom interval for the visible range in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

Timeline.Options

protected Timeline.Options()

Constructor

Method Detail

create

public static Timeline.Options create()

Create a Javascript object instance of Options()

Returns:

new instance of Object

setWidth

public final void setWidth(int width)

Set the width for the timeline in pixels.

Parameters:

width - Width in pixels

setWidth

public final void setWidth(java.lang.String width)

Set the width for the timeline in pixels or percentages.

Parameters:

width - Width as a string, for example "100%" or "500px"

setHeight

public final void setHeight(int height)

Set the height for the timeline in pixels.

Parameters:

height - Height in pixels

setMinHeight

public final void setMinHeight(int minHeight)

Set the minimum height for the timeline in pixels. Useful when height is set to "auto".

Parameters:

minHeight - Minimum height in pixels

setGroupMinHeight

public final void setGroupMinHeight(int groupMinHeight)

Set the minimum group height for the timeline in pixels. Useful when height is set to "auto".

Parameters:

groupMinHeight - Minimum group height in pixels

setCustomStackOrder

public final void setCustomStackOrder(JavaScriptObject customStackOrder)

Set the stack order for the timeline.

Parameters:

customStackOrder - Java script function of the form function (a, b)

setHeight

public final void setHeight(java.lang.String height)

Set the height for the Timeline in pixels or percentages. WHen height is set to "auto", the height of the Timeline is automatically adjusted to fit the contents. See also setMinHeight to set a minimum height.

Parameters:

height - Height as a string, for example "100%" or "500px", or "auto"

setGroupsWidth

public final void setGroupsWidth(int width)

Set the width for the groups legend in pixels.

Parameters:

width - Width in pixels

setGroupsWidth

public final void setGroupsWidth(java.lang.String width)

Set the width for the groups legend in pixels or percentages.

Parameters:

width - Width as a string, for example "100%" or "500px"

setGroupsChangeable

public final void setGroupsChangeable(boolean groupsChangeable)

If true (default), items can be moved from one group to another. Only applicable when groups are used. Default value is true.

Parameters:

groupsChangeable -

setLocale

public final void setLocale(java.lang.String locale)

Set the locale for the timeline.

Parameters:

locale - Available locales: "en", "ca", "de", "da", "ru", "es"

setStart

public final void setStart(java.util.Date start)

Set the start date for the timeline

Parameters:

start - A startdate

setEnd

public final void setEnd(java.util.Date end)

Set the end date for the timeline

Parameters:

end - An end date

setMin

public final void setMin(java.util.Date min)

Set a minimum Date for the visible range. It will not be possible to move beyond this minimum.

Parameters:

min - Minimum date

setMax

public final void setMax(java.util.Date max)

Set a maximum Date for the visible range. It will not be possible to move beyond this maximum.

Parameters:

max - Maximum date

setIntervalMin

@Deprecated
public final void setIntervalMin(long intervalMin)

Deprecated.

Set a minimum interval for the visible range in milliseconds. It will not be possible to zoom in further than this minimum.

Parameters:

intervalMin - Minimum interval in milliseconds (default is 10)

setZoomMin

public final void setZoomMin(long zoomMin)

Set a minimum zoom interval for the visible range in milliseconds. It will not be possible to zoom in further than this minimum.

Parameters:

zoomMin - Minimum interval in milliseconds (default is 10)

setIntervalMax

@Deprecated
public final void setIntervalMax(long intervalMax)

Deprecated.

Set a maximum interval for the visible range in milliseconds. It will not be possible to zoom out further than this maximum. Default value equals about 10000 years.

Parameters:

intervalMax - Maximum interval in milliseconds

setZoomMax

public final void setZoomMax(long zoomMax)

Set a maximum zoom interval for the visible range in milliseconds. It will not be possible to zoom out further than this maximum. Default value equals about 10000 years.

Parameters:

zoomMax - Maximum zoom interval in milliseconds

setScale

public final void setScale(Timeline.Options.SCALE scale,
            double step)

Set a custom scale. Automatic scaling will be disabled. For example scale=SCALE.MINUTES and step=5 will result in minor steps of 5 minutes, and major steps of an hour. Available scales: MILLISECOND, SECOND, MINUTE, HOUR, DAY, MONTH, YEAR. As step size, choose for example 1, 2, 5, or 10.

Parameters:

scale -

step -

setStyle

public final void setStyle(Timeline.Options.STYLE style)

Set the style for the timeline.

Parameters:

style - Choose from BOX (default), or DOT

setAnimate

public final void setAnimate(boolean animate)

Set animate to true (default) or false. When true, events are moved animated when resizing or moving them. This is very pleasing for the eye, but does require more computational power.

Parameters:

animate -

setBoxAlign

public final void setBoxAlign(java.lang.String alignment)

Set alignment for items with style "box". Choose from "center" (default), "left", or "right".

Parameters:

alignment -

setAnimateZoom

public final void setAnimateZoom(boolean animateZoom)

Set animating when zooming to true (default) or false. When true, events are moved animated when zooming the Timeline. This looks cool, but does require more computational power.

Parameters:

animateZoom -

setSnapEvents

public final void setSnapEvents(boolean snapEvents)

If true (default), the start and end of an event will be snapped nice integer values when moving or resizing the event.

Parameters:

snapEvents -

setEventMargin

public final void setEventMargin(int margin)

Set the event margin for the events. The distance between the events will be minimally equal to this distance.

Parameters:

margin - The minimum margin between events, in pixels. Default is 10 pixels.

setEventMarginAxis

public final void setEventMarginAxis(int margin)

Set the minimal distance between the events and the axis.

Parameters:

margin - The minimum margin between events, in pixels. Default is 10 pixels.

setDragAreaWidth

public final void setDragAreaWidth(int dragAreaWidth)

Set the width of the drag areas in pixels. When an event range is selected, it has a drag area on the left and right side, with which the start or end time of the even can be manipulated.

Parameters:

dragAreaWidth - width of the drag areas pixels.

setStackEvents

public final void setStackEvents(boolean stackEvents)

If set to true, the events are stacked above each other to prevent overlapping events.

Parameters:

stackEvents -

setShowMajorLabels

public final void setShowMajorLabels(boolean showMajorLabels)

By default, the timeline shows both minor and major date labels on the horizontal axis. For example the minor labels show minutes and the major labels show hours. When showMajorLabels is false, no major labels are shown.

Parameters:

showMajorLabels -

setShowMinorLabels

public final void setShowMinorLabels(boolean showMinorLabels)

By default, the timeline shows both minor and major date labels on the horizontal axis. For example the minor labels show minutes and the major labels show hours. When showMinorLabels is false, no minor labels are shown. When both showMajorLabels and showMinorLabels are false, no horizontal axis will be visible.

Parameters:

showMinorLabels -

setShowCurrentTime

public final void setShowCurrentTime(boolean show)

If set to true (default), a vertical line is shown at the current time

Parameters:

show -

setShowNavigation

public final void setShowNavigation(boolean show)

If set to true, a navigation menu is shown, containing buttons to move and zoom the timeline. Default value is false.

Parameters:

show -

setShowButtonAdd

public final void setShowButtonAdd(boolean show)

If set to true (default), and the timeline is editable, an add button is shown in the navigation menu

Parameters:

show -

setShowCustomTime

public final void setShowCustomTime(boolean show)

If set to true, the custom time bar is shown. This vertical line can be dragged byIf true, the timeline shows a blue vertical line displaying a custom time. This line can be dragged by the user. The custom time can be utilized to show a state in the past or in the future. When the custom time bar is dragged by the user, an event is triggered, on which the contents of the timeline can be changed in to the state at that moment in time. Default is false

Parameters:

show -

setAxisOnTop

public final void setAxisOnTop(boolean axisOnTop)

If set to true, the axis is shown on top. If false (default), the axis is shown at the bottom

Parameters:

axisOnTop -

setGroupsOnRight

public final void setGroupsOnRight(boolean groupsOnRight)

If set to true, the groups legend is shown at the right. If false (default), the groups are shown at the left.

Parameters:

groupsOnRight -

setMoveable

public final void setMoveable(boolean moveable)

If true (default), the timeline can be moved. When the timeline moved, the rangechange events are fired.

Parameters:

moveable -

setZoomable

public final void setZoomable(boolean zoomable)

If true (default), the timeline can be zoomed. When the timeline is zoomed, the rangechange event is fired.

Parameters:

zoomable -

setSelectable

public final void setSelectable(boolean selectable)

If true (default), the events on the timeline can be selected. n an event is selected, the select event is fired.

Parameters:

selectable -

setEditable

public final void setEditable(boolean editable)

If true (default), the events can be edited, created, deleted. Events can only be editable when the option selectable is true (default). When the Timeline is editable, it can fire events change, edit, add, and delete.

Parameters:

editable -