com.cc.framework.ui.model
Interface GaugeDataModel

All Superinterfaces:

DataModel

All Known Implementing Classes:

GaugeDataModelImp

public interface GaugeDataModel

extends DataModel

Data model for the Gauge Control

Since:

1.4

Version:

$Revision: 1.4 $

Author:

Harald Schulz

Method Summary

double	getAmount(int index) Returns the absolute amount of the given segment.
ClientHandler	getClientHandler(int index) Returns a set of client Handlers for this segment
Color	getColor(int index) Returns the color of the given segment
java.lang.String	getHyperlink(int index) Returns a hyperlink for the given segment
java.lang.String	getTarget(int index) Returns the target where to open the hyperlink
java.lang.String	getText() Returns the text that should be displayed next to the gauge
java.lang.String	getTooltip(int index) Returns the tooltip text for the given segment
int	size() Returns the number of segments of the gauge

Method Detail

getText

public java.lang.String getText()

Returns the text that should be displayed next to the gauge

Returns:

text or null

getAmount

public double getAmount(int index)

Returns the absolute amount of the given segment. The Gauge Control will calculate the segments width from this value.

Parameters:

index - segments index

Returns:

Amount

getTooltip

public java.lang.String getTooltip(int index)

Returns the tooltip text for the given segment

Parameters:

index - segments index

Returns:

Tooltip Text or null

getHyperlink

public java.lang.String getHyperlink(int index)

Returns a hyperlink for the given segment

Parameters:

index - segment index

Returns:

Hyperlink or null

getTarget

public java.lang.String getTarget(int index)

Returns the target where to open the hyperlink

Parameters:

index - segment index

Returns:

Target or null

getClientHandler

public ClientHandler getClientHandler(int index)

Returns a set of client Handlers for this segment

Parameters:

index - segment index

Returns:

Client Handler or null

getColor

public Color getColor(int index)

Returns the color of the given segment

Parameters:

index - segments index

Returns:

Color

size

public int size()

Returns the number of segments of the gauge

Returns:

size