Package adams.gui.visualization.object.overlay

Interface OverlayWithCustomAlphaSupport

All Superinterfaces:

CleanUpHandler, Destroyable, OptionHandler, Overlay

All Known Implementing Classes:

AbstractObjectOverlayFromReport, AbstractPointOverlayFromReport, ClassificationLabelTextOverlay, ObjectAnnotations, ObjectCentersOverlayFromReport, ObjectLocationsOverlayFromReport, SimplePointOverlayFromReport

public interface OverlayWithCustomAlphaSupport
extends Overlay

Interface for overlays that allow alpha values of their color generators to be overwritten.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
int	getCustomAlpha()	Returns the custom alpha value (0: transparent, 255: opaque).
boolean	isCustomAlphaEnabled()	Returns whether a custom alpha value is in use for the overlay colors.
void	setCustomAlpha(int value)	Sets the custom alpha value (0: transparent, 255: opaque).
void	setCustomAlphaEnabled(boolean value)	Sets whether to use a custom alpha value for the overlay colors.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.gui.visualization.object.overlay.Overlay

annotationsChanged, cleanUp, enabledTipText, getEnabled, paint, setEnabled

Method Detail

setCustomAlphaEnabled

void setCustomAlphaEnabled(boolean value)

Sets whether to use a custom alpha value for the overlay colors.

Parameters:

value - true if to use custom alpha

isCustomAlphaEnabled

boolean isCustomAlphaEnabled()

Returns whether a custom alpha value is in use for the overlay colors.

Returns:

true if custom alpha in use

setCustomAlpha

void setCustomAlpha(int value)

Sets the custom alpha value (0: transparent, 255: opaque).

Parameters:

value - the alpha value

getCustomAlpha

int getCustomAlpha()

Returns the custom alpha value (0: transparent, 255: opaque).

Returns:

the alpha value