Package io.keikai.model.impl

Class TimelineImpl

java.lang.Object

io.keikai.model.impl.TimelineImpl

All Implemented Interfaces:

STimeline, Serializable

public class TimelineImpl
extends Object
implements STimeline, Serializable

Default implementation of STimeline.

Since:

7.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.keikai.model.STimeline

STimeline.TimeLevel

Constructor Summary

Constructors

Constructor	Description
TimelineImpl(String name, SPivotTable pivotTable, int fieldIndex)

Method Summary

Modifier and Type	Method	Description
void	clearFilter()	Clears the date filter.
ViewAnchor	getAnchor()	Returns the anchor position of this timeline on the sheet.
String	getCaption()	Returns the display caption.
int	getFieldIndex()	Returns the index of the pivot field (date field) this timeline controls.
Date	getFilterEnd()	Returns the end date of the current filter, or null if no filter.
Date	getFilterStart()	Returns the start date of the current filter, or null if no filter.
STimeline.TimeLevel	getLevel()	Returns the current time level (granularity).
String	getName()	Returns the unique name of this timeline.
SPivotTable	getPivotTable()	Returns the pivot table this timeline is connected to.
void	setAnchor(ViewAnchor anchor)
void	setCaption(String caption)
void	setFieldIndex(int fieldIndex)
void	setFilter(Date start, Date end)	Sets the date filter range.
void	setLevel(STimeline.TimeLevel level)	Sets the time level (granularity).
void	setPivotTable(SPivotTable pivotTable)

Methods inherited from class java.lang.Object

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

Constructor Details

TimelineImpl

public TimelineImpl(String name,
 SPivotTable pivotTable,
 int fieldIndex)

Method Details

getName

public String getName()

Description copied from interface: STimeline

Returns the unique name of this timeline.

Specified by:

getName in interface STimeline

Returns:

the timeline name

getCaption

public String getCaption()

Description copied from interface: STimeline

Returns the display caption.

Specified by:

getCaption in interface STimeline

Returns:

the caption

setCaption

public void setCaption(String caption)

getPivotTable

public SPivotTable getPivotTable()

Description copied from interface: STimeline

Returns the pivot table this timeline is connected to.

Specified by:

getPivotTable in interface STimeline

Returns:

the associated pivot table

setPivotTable

public void setPivotTable(SPivotTable pivotTable)

getFieldIndex

public int getFieldIndex()

Description copied from interface: STimeline

Returns the index of the pivot field (date field) this timeline controls.

Specified by:

getFieldIndex in interface STimeline

Returns:

the field index

setFieldIndex

public void setFieldIndex(int fieldIndex)

getAnchor

public ViewAnchor getAnchor()

Description copied from interface: STimeline

Returns the anchor position of this timeline on the sheet.

Specified by:

getAnchor in interface STimeline

Returns:

the view anchor

setAnchor

public void setAnchor(ViewAnchor anchor)

getLevel

public STimeline.TimeLevel getLevel()

Description copied from interface: STimeline

Returns the current time level (granularity).

Specified by:

getLevel in interface STimeline

Returns:

the time level

setLevel

public void setLevel(STimeline.TimeLevel level)

Description copied from interface: STimeline

Sets the time level (granularity).

Specified by:

setLevel in interface STimeline

Parameters:

level - the time level

getFilterStart

public Date getFilterStart()

Description copied from interface: STimeline

Returns the start date of the current filter, or null if no filter.

Specified by:

getFilterStart in interface STimeline

Returns:

the filter start date

getFilterEnd

public Date getFilterEnd()

Description copied from interface: STimeline

Returns the end date of the current filter, or null if no filter.

Specified by:

getFilterEnd in interface STimeline

Returns:

the filter end date

setFilter

public void setFilter(Date start,
 Date end)

Description copied from interface: STimeline

Sets the date filter range.

Specified by:

setFilter in interface STimeline

Parameters:

start - the start date (inclusive)

end - the end date (inclusive)

clearFilter

public void clearFilter()

Description copied from interface: STimeline

Clears the date filter.

Specified by:

clearFilter in interface STimeline