com.ge.research.acuity.ui
Interface HighlightRegion

All Known Implementing Classes:

HighlightRegionColumnInfo, HighlightRegionDataseries

public interface HighlightRegion

Describes the methods and behaviors of a HighlightRegion. HighlightRegions can be applied to TablePOs and GraphPOs. HighlightRegions on a graph display a slice along an axis, while table highlights are displayed as colored rows.

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:24 $

Author:

garbiras

Field Summary

static java.awt.Color

DEFAULT_HIGHLIGHT_COLOR The default color for a HighlightRegion

Method Summary

void	disableInvalidThresholds() A highlight region can have either range thresholds or a discrete value, but not both.
int	getAlpha() Returns the opaqueness component of the highlight region Color The component value is in the range 0-255
java.lang.Object	getAppliesTo() Returns the appliesTo reference for the highlight region.
int	getBlueVal() Returns the RGB blue value component of the highlight region Color The component value is in the range 0-255
java.awt.Color	getColor() Returns the color to be used when rendering this highlight region.
int	getGreenVal() Returns the RGB green value component of the highlight region Color The component value is in the range 0-255
java.lang.String	getHasDiscreteValue() Gets the discrete value threshold value for the highlight region.
double	getHiThreshold() Gets the upper threshold value for the highlight region.
double	getLoThreshold() Gets the lower threshold value for the highlight region.
java.lang.String	getName() Returns the highlight region identifier.
int	getRedVal() Returns the RGB red value component of the highlight region Color The component value is in the range 0-255
boolean	isDisplayed() Returns the state of the highlight region visibility.
void	setAlpha(int i) Sets the opaqueness component of the highlight region Color The component value must in the range 0-255.
void	setAppliesTo(java.lang.Object appliesTo) Sets the appliesTo reference for the highlight region.
void	setBlueVal(int i) Sets the RGB blue value component of the highlight region Color The component value must in the range 0-255.
void	setColor(java.awt.Color color) Sets the color component values, for the highlight region, from the argument color
void	setColor(int red, int green, int blue) Sets the RGB color component values, for the highlight region
void	setColor(int red, int green, int blue, int alpha) Sets the RGB color component values and opaqueness value, for the highlight region
void	setGreenVal(int i) Sets the RGB green value component of the highlight region Color The component value must in the range 0-255.
void	setHasDiscreteValue(java.lang.String discVal) Sets the discrete value threshold value for the highlight region.
void	setHiThreshold(double hi) Sets the upper threshold value for the highlight region.
void	setIsDisplayed(boolean b) Sets the state of the highlight region visibility.
void	setLoThreshold(double lo) Sets the lower threshold value for the highlight region.
void	setName(java.lang.String name) Sets the highlight region identifier
void	setRedVal(int i) Sets the RGB red value component of the highlight region Color The component value must in the range 0-255.

Field Detail

DEFAULT_HIGHLIGHT_COLOR

public static final java.awt.Color DEFAULT_HIGHLIGHT_COLOR

The default color for a HighlightRegion

Method Detail

disableInvalidThresholds

public void disableInvalidThresholds()

A highlight region can have either range thresholds or a discrete value, but not both. This method is used to enforce this consistency by not allowing thresholds to be modified unless they were the original types declared when the highlight region was created. Sets the editability of either the range threshold parameters, or the discrete value parameter, to false depending on the information used from the ontology to construct it.

getAlpha

public int getAlpha()

Returns the opaqueness component of the highlight region Color The component value is in the range 0-255

Returns:

The opaqueness component of the highlight region color

getAppliesTo

public java.lang.Object getAppliesTo()

Returns the appliesTo reference for the highlight region. It is either the x or y axis, or table column number.

Returns:

The value of the appliesTo reference for the highlight region

getBlueVal

public int getBlueVal()

Returns the RGB blue value component of the highlight region Color The component value is in the range 0-255

Returns:

The RGB blue value component of the highlight region color

getColor

public java.awt.Color getColor()

Returns the color to be used when rendering this highlight region. The color is constructed from the component RGB values and opaque value of this highlight region.

Returns:

The display color for the highlight region

getGreenVal

public int getGreenVal()

Returns the RGB green value component of the highlight region Color The component value is in the range 0-255

Returns:

The RGB green value component of the highlight region color

getHasDiscreteValue

public java.lang.String getHasDiscreteValue()

Gets the discrete value threshold value for the highlight region.

Returns:

The discrete value threshold value for the highlight region

getHiThreshold

public double getHiThreshold()

Gets the upper threshold value for the highlight region.

Returns:

The upper threshold value for the highlight region

getLoThreshold

public double getLoThreshold()

Gets the lower threshold value for the highlight region.

Returns:

The lower threshold value for the highlight region

getName

public java.lang.String getName()

Returns the highlight region identifier.

Returns:

The highlight region identifier

getRedVal

public int getRedVal()

Returns the RGB red value component of the highlight region Color The component value is in the range 0-255

Returns:

The RGB red value component of the highlight region color

isDisplayed

public boolean isDisplayed()

Returns the state of the highlight region visibility.

Returns:

true if this highlight region should be applied and rendered by a client application; false if this highlight region should not be applied and made visible in a client application.

setAlpha

public void setAlpha(int i)

Sets the opaqueness component of the highlight region Color The component value must in the range 0-255. Argument values less than zero should set the opaqueness to zero Argument values greater than 255 should set the opaqueness to 255

Parameters:

i - the opaqueness component of the highlight region color

setAppliesTo

public void setAppliesTo(java.lang.Object appliesTo)

Sets the appliesTo reference for the highlight region. Associates the highlight region with either the x or y axis, or table column number.

Parameters:

appliesTo - the value of the appliesTo reference for the highlight region

setBlueVal

public void setBlueVal(int i)

Sets the RGB blue value component of the highlight region Color The component value must in the range 0-255. Argument values less than zero should set the blue component value to zero Argument values greater than 255 should set the blue component value to 255

Parameters:

i - the RGB blue value component of the highlight region color

setColor

public void setColor(java.awt.Color color)

Sets the color component values, for the highlight region, from the argument color

Parameters:

color - the new color for the highlight region

setColor

public void setColor(int red,
                     int green,
                     int blue)

Sets the RGB color component values, for the highlight region

Parameters:

red - the new RGB red value for the highlight region color

green - the new RGB green value for the highlight region color

blue - the new RGB blue value for the highlight region color

setColor

public void setColor(int red,
                     int green,
                     int blue,
                     int alpha)

Sets the RGB color component values and opaqueness value, for the highlight region

Parameters:

red - the new RGB red value for the highlight region color

green - the new RGB green value for the highlight region color

blue - the new RGB blue value for the highlight region color

alpha - the new opaqueness value for the highlight region color

setGreenVal

public void setGreenVal(int i)

Sets the RGB green value component of the highlight region Color The component value must in the range 0-255. Argument values less than zero should set the green component value to zero Argument values greater than 255 should set the green component value to 255

Parameters:

i - the RGB green value component of the highlight region color

setHasDiscreteValue

public void setHasDiscreteValue(java.lang.String discVal)

Sets the discrete value threshold value for the highlight region.

Parameters:

discVal - the discrete value threshold value for the highlight region

setHiThreshold

public void setHiThreshold(double hi)

Sets the upper threshold value for the highlight region.

Parameters:

hi - the upper threshold value for the highlight region

setIsDisplayed

public void setIsDisplayed(boolean b)

Sets the state of the highlight region visibility.

Parameters:

b - true if this highlight region should be applied and rendered by a client application; false if this highlight region should not be applied and made visible in a client application.

setLoThreshold

public void setLoThreshold(double lo)

Sets the lower threshold value for the highlight region.

Parameters:

lo - the lower threshold value for the highlight region

setName

public void setName(java.lang.String name)

Sets the highlight region identifier

Parameters:

name - the new identifier for the highlight region

setRedVal

public void setRedVal(int i)

Sets the RGB red value component of the highlight region Color The component value must in the range 0-255. Argument values less than zero should set the red component value to zero Argument values greater than 255 should set the red component value to 255

Parameters:

i - the RGB red value component of the highlight region color