oracle.dss.dataView

Interface UIThresholdColor

All Known Implementing Classes:

Threshold

public interface UIThresholdColor

For internal use only. Application developers should not use this

The interface that defines the color properties for a threshold in a funnel graph. This interface is implemented internally and is used by the BI Beans user interface panels. Application developers should not implement this interface.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor(int threshold) Retrieves the fill color for the markers of the funnel threshold.
int	getThresholdId(int group) Retrieves the index of the threshold for a given group.
boolean	isXMLBeingSet() Checks if XML setting is on
void	setColor(java.awt.Color newColor, int threshold) Specifies the fill color for the markers of the funnel threshold.

Method Detail

getColor

java.awt.Color getColor(int threshold)
                 throws ThresholdOutOfRangeException

Retrieves the fill color for the markers of the funnel threshold.

Parameters:

threshold - the index of the threshold. The values range from 0 to the value of graph.getThresholdObjectCount minus 1.

Returns:

the fill color for the markers of the threshold

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

setColor

void setColor(java.awt.Color newColor,
              int threshold)
       throws ThresholdOutOfRangeException

Specifies the fill color for the markers of the funnel threshold.

Parameters:

threshold - the index of the threshold. The values range from 0 to the value of graph.getThresholdObjectCount minus 1.

newColor - the fill color for the markers of the threshold

Throws:

SeriesOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

See Also:

Graph.getThresholdObjectCount()

getThresholdId

int getThresholdId(int group)

Retrieves the index of the threshold for a given group.

Parameters:

group - the group index

Returns:

the threshold index for the given group

isXMLBeingSet

boolean isXMLBeingSet()

Checks if XML setting is on

Returns:

true if xml setting is on false if xml setting is off