com.azalient.api.b.display
Interface IViewable

public interface IViewable

A viewable object is similar to a feature

Method Summary

boolean	isOff(int aspectIndex) Returns true if this feature is off in the given aspect.
boolean	isVisible(int aspectIndex) Returns true if this feature is on in the given aspect.
void	off(int aspectIndex, boolean off) Sets the visibility of this feature in the given aspect.
boolean	promptIfInvisible(int aspectIndex) Checks if this viewable is visible in the given aspect (normally the current aspect), and if not, raises a dialog to ask the user if it should be made visible
int	rgb(int aspectIndex) Returns the colour assigned to this feature in the given aspect.
void	rgb(int aspectIndex, int argb) Sets the colour assigned to this feature in the given aspect.
void	visible(int aspectIndex, boolean visible) Sets the visibility of this feature in the given aspect.

Method Detail

promptIfInvisible

boolean promptIfInvisible(int aspectIndex)

Checks if this viewable is visible in the given aspect (normally the current aspect), and if not, raises a dialog to ask the user if it should be made visible

isVisible

boolean isVisible(int aspectIndex)

Returns true if this feature is on in the given aspect. This is the inverse of isOff(int)

visible

void visible(int aspectIndex,
             boolean visible)

Sets the visibility of this feature in the given aspect. This is the inverse of off(int, boolean)

isOff

boolean isOff(int aspectIndex)

Returns true if this feature is off in the given aspect. This is the inverse of isVisible(int)

off

void off(int aspectIndex,
         boolean off)

Sets the visibility of this feature in the given aspect. This is the inverse of visible(int, boolean)

rgb

int rgb(int aspectIndex)

Returns the colour assigned to this feature in the given aspect.

Returns:

a 32-bit ARGB colour value

rgb

void rgb(int aspectIndex,
         int argb)

Sets the colour assigned to this feature in the given aspect.

Parameters:

aspectIndex - the index of an aspect

argb - a 32-bit ARGB colour value