com.dlsc.flexgantt.policy.gantt
Class TimeGranularityStatusBarPolicy

java.lang.Object
  extended by com.dlsc.flexgantt.policy.AbstractPolicy
      extended by com.dlsc.flexgantt.policy.gantt.AbstractStatusBarPolicy
          extended by com.dlsc.flexgantt.policy.gantt.TimeGranularityStatusBarPolicy
All Implemented Interfaces:
IStatusBarPolicy, IPolicy

public class TimeGranularityStatusBarPolicy
extends AbstractStatusBarPolicy
implements IStatusBarPolicy

An implementation of the status bar policy used in situations where the dateline model is an instance of TimeGranularityDatelineModel. For more information on the purpose of the policy please refer to the documentation of IStatusBarPolicy.

Since:
1.0
Author:
Dirk Lemmermann

Constructor Summary
TimeGranularityStatusBarPolicy()
           
 
Method Summary
 java.text.DateFormat getFormat()
          Returns the date formatting object used by the policy methods to format the given time points and time spans.
 java.lang.String getTimeNowString(IDatelineModel model, long time)
          Returns a string representing the given time point, which represents time now.
 java.lang.String getTimeSpanString(IDatelineModel model, ITimeSpan span)
          Returns a string representing the given time span.
 java.lang.String getTimeString(IDatelineModel model, long time)
          Returns a string representing the given time point.
 void setFormat(java.text.DateFormat format)
          Sets the date formatting object used by the policy methods to format the given time points and time spans.
 
Methods inherited from class com.dlsc.flexgantt.policy.gantt.AbstractStatusBarPolicy
addStatusBarFields, isStatusBarFieldVisible, removeStatusBarFields
 
Methods inherited from class com.dlsc.flexgantt.policy.AbstractPolicy
assertClass
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.dlsc.flexgantt.policy.gantt.IStatusBarPolicy
isStatusBarFieldVisible
 

Constructor Detail

TimeGranularityStatusBarPolicy

public TimeGranularityStatusBarPolicy()
Method Detail

getTimeNowString

public java.lang.String getTimeNowString(IDatelineModel model,
                                         long time)
Description copied from interface: IStatusBarPolicy
Returns a string representing the given time point, which represents time now.

Specified by:
getTimeNowString in interface IStatusBarPolicy
Parameters:
model - the dateline model currently used by the Gantt chart
time - the time (now) point for which to return a string
Returns:
a text representation of the given time point

getTimeSpanString

public java.lang.String getTimeSpanString(IDatelineModel model,
                                          ITimeSpan span)
Description copied from interface: IStatusBarPolicy
Returns a string representing the given time span.

Specified by:
getTimeSpanString in interface IStatusBarPolicy
Parameters:
model - the dateline model currently used by the Gantt chart
span - the time span for which to return a string
Returns:
a text representation of the given time span

getTimeString

public java.lang.String getTimeString(IDatelineModel model,
                                      long time)
Description copied from interface: IStatusBarPolicy
Returns a string representing the given time point.

Specified by:
getTimeString in interface IStatusBarPolicy
Parameters:
model - the dateline model currently used by the Gantt chart
time - the time point for which to return a string
Returns:
a text representation of the given time point

getFormat

public java.text.DateFormat getFormat()
Returns the date formatting object used by the policy methods to format the given time points and time spans. The default formatter gets set via a call to DateFormat.getInstance().

Returns:
the date formatting object
Since:
1.0
See Also:
setFormat(DateFormat)

setFormat

public void setFormat(java.text.DateFormat format)
Sets the date formatting object used by the policy methods to format the given time points and time spans. The default formatter gets set via a call to DateFormat.getInstance().

Parameters:
format -
Since:
1.0