Gephi Toolkit Javadoc

org.gephi.timeline
Class TimelineModelImpl

java.lang.Object
  extended by org.gephi.timeline.TimelineModelImpl
All Implemented Interfaces:
TimelineModel

public class TimelineModelImpl
extends java.lang.Object
implements TimelineModel

Author:
Mathieu Bastian

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.gephi.timeline.api.TimelineModel
TimelineModel.PlayMode
 
Constructor Summary
TimelineModelImpl(DynamicModel dynamicModel)
           
 
Method Summary
 TimelineChart getChart()
          Returns the current timeline chart or null if node.
 double getCustomMax()
          Returns the custom max value.
 double getCustomMin()
          Returns the custom min value.
 DynamicModel getDynamicModel()
           
 double getIntervalEnd()
          Returns the upper bound of the interval.
 double getIntervalStart()
          Returns the lower bound of the interval.
 double getMax()
          Returns the max value of the time scale.
 double getMin()
          Returns the min value of the time scale.
 int getPlayDelay()
          Returns the play delay in milliseconds.
 TimelineModel.PlayMode getPlayMode()
          Returns the play mode.
 double getPlayStep()
          Returns the play step.
 double getPreviousMax()
           
 double getPreviousMin()
           
 DynamicModel.TimeFormat getTimeFormat()
          Returns the current time format.
 boolean hasCustomBounds()
          Returns true if custom bounds are defined.
 boolean hasValidBounds()
          Returns true if none of the min and max time values are infinity.
 boolean isEnabled()
          Returns true if the timeline is enabled.
 boolean isPlaying()
          Returns true if the timeline is playing.
 void setChart(TimelineChart chart)
           
 void setCustomMax(double customMax)
           
 void setCustomMin(double customMin)
           
 void setEnabled(boolean enabled)
           
 void setPlayDelay(int playDelay)
           
 void setPlaying(boolean playing)
           
 void setPlayMode(TimelineModel.PlayMode playMode)
           
 void setPlayStep(double playStep)
           
 void setPreviousMax(double previousMax)
           
 void setPreviousMin(double previousMin)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimelineModelImpl

public TimelineModelImpl(DynamicModel dynamicModel)
Method Detail

isEnabled

public boolean isEnabled()
Description copied from interface: TimelineModel
Returns true if the timeline is enabled. When enabled, the timeline is filtering the current graph.

Specified by:
isEnabled in interface TimelineModel
Returns:
true if the timeline is enabled, false otherwise

getMin

public double getMin()
Description copied from interface: TimelineModel
Returns the min value of the time scale. This is the start of the earliest interval in the workspace.

Specified by:
getMin in interface TimelineModel
Returns:
the min

getMax

public double getMax()
Description copied from interface: TimelineModel
Returns the max value of the time scale. This is the end of the latest interval in the workspace.

Specified by:
getMax in interface TimelineModel
Returns:
the max

getPreviousMin

public double getPreviousMin()

getPreviousMax

public double getPreviousMax()

setPreviousMax

public void setPreviousMax(double previousMax)

setPreviousMin

public void setPreviousMin(double previousMin)

getCustomMin

public double getCustomMin()
Description copied from interface: TimelineModel
Returns the custom min value. This value can't be inferior than min

Specified by:
getCustomMin in interface TimelineModel
Returns:
the custom min

getCustomMax

public double getCustomMax()
Description copied from interface: TimelineModel
Returns the custom max value. This value can't be superior than max

Specified by:
getCustomMax in interface TimelineModel
Returns:
the custom max

hasCustomBounds

public boolean hasCustomBounds()
Description copied from interface: TimelineModel
Returns true if custom bounds are defined. Returns false when custom bounds are equal to min and max.

Specified by:
hasCustomBounds in interface TimelineModel
Returns:
true if custom bounds are defined, false otherwise.

getIntervalStart

public double getIntervalStart()
Description copied from interface: TimelineModel
Returns the lower bound of the interval.

Specified by:
getIntervalStart in interface TimelineModel
Returns:
the interval start

getIntervalEnd

public double getIntervalEnd()
Description copied from interface: TimelineModel
Returns the upper bound of the interval.

Specified by:
getIntervalEnd in interface TimelineModel
Returns:
the interval end

getTimeFormat

public DynamicModel.TimeFormat getTimeFormat()
Description copied from interface: TimelineModel
Returns the current time format. Default is DOUBLE

Specified by:
getTimeFormat in interface TimelineModel
Returns:
the current tie

getDynamicModel

public DynamicModel getDynamicModel()

setCustomMax

public void setCustomMax(double customMax)

setCustomMin

public void setCustomMin(double customMin)

setEnabled

public void setEnabled(boolean enabled)

hasValidBounds

public boolean hasValidBounds()
Description copied from interface: TimelineModel
Returns true if none of the min and max time values are infinity.

Specified by:
hasValidBounds in interface TimelineModel
Returns:
true if the time scale is valid, false otherwise

isPlaying

public boolean isPlaying()
Description copied from interface: TimelineModel
Returns true if the timeline is playing.

Specified by:
isPlaying in interface TimelineModel
Returns:
true is playing, false otherwise

setPlaying

public void setPlaying(boolean playing)

getPlayDelay

public int getPlayDelay()
Description copied from interface: TimelineModel
Returns the play delay in milliseconds. Defines the time between each interval shift.

Specified by:
getPlayDelay in interface TimelineModel
Returns:
the play delay

setPlayDelay

public void setPlayDelay(int playDelay)

getPlayStep

public double getPlayStep()
Description copied from interface: TimelineModel
Returns the play step. Defines how much the interval is moved at each step during animation. Defined in percentage of the total interval.

Specified by:
getPlayStep in interface TimelineModel
Returns:
the play step

setPlayStep

public void setPlayStep(double playStep)

getPlayMode

public TimelineModel.PlayMode getPlayMode()
Description copied from interface: TimelineModel
Returns the play mode. This defines how the interval is moved.

Specified by:
getPlayMode in interface TimelineModel
Returns:
the play mode

setPlayMode

public void setPlayMode(TimelineModel.PlayMode playMode)

getChart

public TimelineChart getChart()
Description copied from interface: TimelineModel
Returns the current timeline chart or null if node.

Specified by:
getChart in interface TimelineModel
Returns:
the timeline chart or null

setChart

public void setChart(TimelineChart chart)

Gephi Toolkit Javadoc