com.androidplot.ui

Class Formatter<PlotType extends Plot>

java.lang.Object

com.androidplot.ui.Formatter<PlotType>

Direct Known Subclasses:

SegmentFormatter, XYSeriesFormatter

public abstract class Formatter<PlotType extends Plot>
extends java.lang.Object

Base class of all Formatters. Encapsulates visual elements of a series; line style, color etc. Implementors of this class should include both a default constructor and a one argument constructor in the following form:

 
 // provided as a convenience to users; allows instantiation and
 // xml configuration in a single line.
 public MyFormatter(Context ctx, int xmlCfgId) {
     // prevent configuration of classes derived from this one:
     if (getClass().equals(MyFormatter.class)) {
         Configurator.configure(ctx, this, xmlCfgId);
     }
 }
 

Constructor Summary

Constructors

Constructor and Description
Formatter()
Formatter(android.content.Context ctx, int xmlCfgId)

Method Summary

Modifier and Type	Method and Description
void	configure(android.content.Context ctx, int xmlCfgId)
protected abstract SeriesRenderer	doGetRendererInstance(PlotType plot)
abstract java.lang.Class<? extends SeriesRenderer>	getRendererClass()
<T extends SeriesRenderer> T	getRendererInstance(PlotType plot)
boolean	isLegendIconEnabled()
void	setLegendIconEnabled(boolean legendIconEnabled) Sets whether or not a legend icon should be drawn for the series associated with this formatter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Formatter

public Formatter()

Formatter

public Formatter(android.content.Context ctx,
                 int xmlCfgId)

Method Detail

configure

public void configure(android.content.Context ctx,
                      int xmlCfgId)

getRendererInstance

public <T extends SeriesRenderer> T getRendererInstance(PlotType plot)

Type Parameters:

T -

Parameters:

plot -

Returns:

@return An instance of SeriesRenderer constructed with the specified plot.

getRendererClass

public abstract java.lang.Class<? extends SeriesRenderer> getRendererClass()

Returns:

The Class of SeriesRenderer that should be used when rendering series associated with instances of this formatter.

doGetRendererInstance

protected abstract SeriesRenderer doGetRendererInstance(PlotType plot)

Returns:

An instance of SeriesRenderer constructed with the specified plot.

isLegendIconEnabled

public boolean isLegendIconEnabled()

setLegendIconEnabled

public void setLegendIconEnabled(boolean legendIconEnabled)

Sets whether or not a legend icon should be drawn for the series associated with this formatter.

Parameters:

legendIconEnabled -