com.androidplot.ui.widget

Class LegendWidget<ItemT extends LegendItem>

java.lang.Object

com.androidplot.ui.widget.Widget

com.androidplot.ui.widget.LegendWidget<ItemT>

Type Parameters:

ItemT -

All Implemented Interfaces:

BoxModelable, Resizable

Direct Known Subclasses:

PieLegendWidget, XYLegendWidget

public abstract class LegendWidget<ItemT extends LegendItem>
extends Widget

Provides core functionality for displaying a legend widget within a Plot.

Nested Class Summary

Nested classes/interfaces inherited from class com.androidplot.ui.widget.Widget

Widget.Rotation

Constructor Summary

Constructors

Constructor and Description
LegendWidget(TableModel tableModel, LayoutManager layoutManager, Size size, Size iconSize)

Method Summary

Modifier and Type	Method and Description
protected void	beginDrawingCell(android.graphics.Canvas canvas, android.graphics.RectF iconRect) Done at the start of rendering a new cell.
protected void	doOnDraw(android.graphics.Canvas canvas, android.graphics.RectF widgetRect)
protected abstract void	drawIcon(android.graphics.Canvas canvas, android.graphics.RectF iconRect, ItemT item) Draw the icon representing the legend item
protected void	drawItem(android.graphics.Canvas canvas, android.graphics.RectF iconRect, ItemT item)
protected void	finishDrawingCell(android.graphics.Canvas canvas, android.graphics.RectF cellRect, android.graphics.RectF iconRect, LegendItem legendItem) Done at the end of rendering a new cell.
Size	getIconSize()
Comparator<ItemT>	getLegendItemComparator()
protected abstract List<ItemT>	getLegendItems()
protected static float	getRectCenterY(android.graphics.RectF cellRect)
android.graphics.Paint	getTextPaint()
boolean	isDrawIconBackgroundEnabled()
boolean	isDrawIconBorderEnabled()
void	setDrawIconBackgroundEnabled(boolean drawIconBackgroundEnabled)
void	setDrawIconBorderEnabled(boolean drawIconBorderEnabled)
void	setIconSize(Size iconSize)
void	setLegendItemComparator(Comparator<ItemT> legendItemComparator) Set a scheme for sorting the display order or legend items.
void	setTableModel(TableModel tableModel)
void	setTextPaint(android.graphics.Paint textPaint)

Methods inherited from class com.androidplot.ui.widget.Widget

applyRotation, containsPoint, draw, drawBackground, drawBorder, getAnchor, getAnchorCoordinates, getAnchorCoordinates, getAnchorOffset, getBackgroundPaint, getBorderPaint, getElementCoordinates, getHeightMetric, getHeightPix, getMarginatedRect, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddedRect, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPositionMetrics, getRotation, getSize, getWidgetDimensions, getWidthMetric, getWidthPix, isClippingEnabled, isVisible, layout, onMetricsChanged, onPostInit, position, position, refreshLayout, setAnchor, setBackgroundPaint, setBorderPaint, setClippingEnabled, setHeight, setHeight, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPositionMetrics, setRotation, setSize, setVisible, setWidth, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

LegendWidget

public LegendWidget(TableModel tableModel,
                    LayoutManager layoutManager,
                    Size size,
                    Size iconSize)

Method Detail

doOnDraw

protected void doOnDraw(android.graphics.Canvas canvas,
                        android.graphics.RectF widgetRect)
                 throws PlotRenderException

Specified by:

doOnDraw in class Widget

Parameters:

canvas - The Canvas to draw onto

widgetRect - the size and coordinates of this widget

Throws:

PlotRenderException

drawItem

protected void drawItem(android.graphics.Canvas canvas,
                        android.graphics.RectF iconRect,
                        ItemT item)

drawIcon

protected abstract void drawIcon(android.graphics.Canvas canvas,
                                 android.graphics.RectF iconRect,
                                 ItemT item)

Draw the icon representing the legend item

Parameters:

canvas -

iconRect - The space to be occupied by the icon.

item -

getLegendItems

protected abstract List<ItemT> getLegendItems()

Returns:

The list of legend items to be drawn. This is used to calculate table dimensions etc.

beginDrawingCell

protected void beginDrawingCell(android.graphics.Canvas canvas,
                                android.graphics.RectF iconRect)

Done at the start of rendering a new cell. Whatever is drawn here will be beneath the rest of the cell content; typically used to draw backgrounds.

Parameters:

canvas -

iconRect -

finishDrawingCell

protected void finishDrawingCell(android.graphics.Canvas canvas,
                                 android.graphics.RectF cellRect,
                                 android.graphics.RectF iconRect,
                                 LegendItem legendItem)

Done at the end of rendering a new cell. Whatever is drawn here will be on top of the rest of the cell content; typically used to draw borders and text.

Parameters:

canvas -

cellRect -

iconRect -

legendItem -

getRectCenterY

protected static float getRectCenterY(android.graphics.RectF cellRect)

setTableModel

public void setTableModel(TableModel tableModel)

getTextPaint

public android.graphics.Paint getTextPaint()

setTextPaint

public void setTextPaint(android.graphics.Paint textPaint)

isDrawIconBackgroundEnabled

public boolean isDrawIconBackgroundEnabled()

setDrawIconBackgroundEnabled

public void setDrawIconBackgroundEnabled(boolean drawIconBackgroundEnabled)

isDrawIconBorderEnabled

public boolean isDrawIconBorderEnabled()

setDrawIconBorderEnabled

public void setDrawIconBorderEnabled(boolean drawIconBorderEnabled)

getIconSize

public Size getIconSize()

setIconSize

public void setIconSize(Size iconSize)

getLegendItemComparator

public Comparator<ItemT> getLegendItemComparator()

setLegendItemComparator

public void setLegendItemComparator(Comparator<ItemT> legendItemComparator)

Set a scheme for sorting the display order or legend items. By default no sorting is applied and Series items typically appear in the order which the series was added to the Plot.

Parameters:

legendItemComparator -