com.jidesoft.scale
Class AbstractPeriodConverter<T>

java.lang.Object
  com.jidesoft.scale.AbstractPeriodConverter<T>

Type Parameters:

T - The base unit of the ScaleModel to render the periods for.

All Implemented Interfaces:

PeriodConverter<T>, Serializable

Direct Known Subclasses:

DatePeriodConverter, DefaultPeriodConverter

public abstract class AbstractPeriodConverter<T>
extends Object
implements PeriodConverter<T>, Serializable

Abstract implementation of PeriodConverter.

See Also:

Serialized Form

Constructor Summary

AbstractPeriodConverter()

AbstractPeriodConverter(String periodName)

Method Summary

String	getDisplayName() Gets the period display name.
T	getPrototypeDisplayValue() Getes the prototype value.
void	setPrototypeDisplayValue(T prototypeDisplayValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.scale.PeriodConverter

getDescription, getText

Constructor Detail

AbstractPeriodConverter

public AbstractPeriodConverter()

AbstractPeriodConverter

public AbstractPeriodConverter(String periodName)

Method Detail

getPrototypeDisplayValue

public T getPrototypeDisplayValue()

Description copied from interface: PeriodConverter

Getes the prototype value. The value represents the longest expected string length for the period for the getText method.

Specified by:

getPrototypeDisplayValue in interface PeriodConverter<T>

Returns:

a value which represents the longest expected string length for the period to calculate the preferred with.

getDisplayName

public String getDisplayName()

Description copied from interface: PeriodConverter

Gets the period display name. The display name will be used in the places to represent the period.

Specified by:

getDisplayName in interface PeriodConverter<T>

Returns:

the display name for a particular period.

setPrototypeDisplayValue

public void setPrototypeDisplayValue(T prototypeDisplayValue)