All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface guinea.ui.ControlInterface

public interface ControlInterface

This interface is implemented by user interface components that provide controls to the subject. Control components include such controls as volume level slider or selecting a sample to play.

Method Index

· addControlListener(ControlListener): Add a control listener to receive events from this control component.
· getControlValue(): Get the value of this controller.
· isControlEnabled(): Test whether control is enabled or disabled.
· removeControlListener(ControlListener): Remove a control listener so that control events are no longer sent to that listener.
· reset(): Reset control to default value.
· setControlEnabled(boolean): Enable or disable control component.
· setControlValue(Object): Set the value of this controller.

Methods

· setControlEnabled

 public abstract void setControlEnabled(boolean enabled)

Enable or disable control component.

Parameters:: enabled - Use true to enable, false to disable the controller.

· isControlEnabled

 public abstract boolean isControlEnabled()

Test whether control is enabled or disabled.

Returns:: true if controller is enabled, false if not.

· setControlValue

 public abstract void setControlValue(Object value)

Set the value of this controller. Can be used to set initial value of controlled variable.

Parameters:: value - the value to set.

· getControlValue

 public abstract Object getControlValue()

Get the value of this controller. Can also be used to get initial value of controlled variable.

Returns:: The control's value.

· addControlListener

 public abstract void addControlListener(ControlListener listener)

Add a control listener to receive events from this control component.

Parameters:: listener - a listener

· removeControlListener

 public abstract void removeControlListener(ControlListener listener)

Remove a control listener so that control events are no longer sent to that listener.

Parameters:: listener - a listener

· reset

 public abstract void reset()

Reset control to default value.

All Packages  Class Hierarchy  This Package  Previous  Next  Index