com.sun.tv.media.controls

Class AtomicControlAdapter

java.lang.Object

com.sun.tv.media.controls.AtomicControlAdapter

All Implemented Interfaces:

AtomicControl, Control

Direct Known Subclasses:

NumericControlAdapter

public class AtomicControlAdapter
extends Object
implements AtomicControl

This class is a part of the porting layer implementation for JavaTV. An AtomicControl is one that can be treated as an individual control and can have its own behaviour. It is a base class for other controls.

Field Summary

Fields

Modifier and Type	Field and Description
protected Component	component VARIABLES
protected boolean	enabled
protected boolean	isdefault
protected Control	parent

Constructor Summary

Constructors

Constructor and Description
AtomicControlAdapter(Component c, boolean def, Control parent) constructs an atomic control adapter.

Method Summary

Methods

Modifier and Type	Method and Description
void	addControlChangeListener(ControlChangeListener ccl) Add a listener that should be informed if any state of this control changes.
Component	getControlComponent() returns control component associated with the control adapter
boolean	getEnabled() Returns the enabled/disabled state of the control.
Control	getParent() Returns the control group to which this control belongs, if any.
String	getTip() Sun specific - Returns the description string for this control.
boolean	getVisible() Returns true if this control is available on the control panel.
void	informListeners() informs listeners about changes in control's state
boolean	isDefault() Returns true if this control is available on the default control panel returned for the player in question.
boolean	isReadOnly() returns whether the control is read only return true if the control is read-only
void	removeControlChangeListener(ControlChangeListener ccl) Remove an already added listener.
void	setEnabled(boolean enabled) Set the enabled/disabled state of the control.
void	setParent(Control p) sets the parent control for the specified control
void	setTip(String tip) Sun specific - Sets the description string for this control.
void	setVisible(boolean visible) Specify whether this control should be available on the control panel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

component

protected Component component

VARIABLES

isdefault

protected boolean isdefault

parent

protected Control parent

enabled

protected boolean enabled

Constructor Detail

AtomicControlAdapter

public AtomicControlAdapter(Component c,
                    boolean def,
                    Control parent)

constructs an atomic control adapter.

Parameters:

c - a component the atomic control adapter is associated with

def - specifies whether the control belongs to the default control panel

parent - parent control

Method Detail

isDefault

public boolean isDefault()

Returns true if this control is available on the default control panel returned for the player in question.

Specified by:

isDefault in interface AtomicControl

setVisible

public void setVisible(boolean visible)

Specify whether this control should be available on the control panel. ???

Specified by:

setVisible in interface AtomicControl

Parameters:

visible - if true, the control is visible

getVisible

public boolean getVisible()

Returns true if this control is available on the control panel. ???

Specified by:

getVisible in interface AtomicControl

setEnabled

public void setEnabled(boolean enabled)

Set the enabled/disabled state of the control. Can be useful to temporarily gray out a control due to some constraints.

Specified by:

setEnabled in interface AtomicControl

Parameters:

enabled - if true, the control is enabled

getEnabled

public boolean getEnabled()

Returns the enabled/disabled state of the control.

Specified by:

getEnabled in interface AtomicControl

Returns:

the enabled/disabled state of the control.

setParent

public void setParent(Control p)

sets the parent control for the specified control

Parameters:

p - parent control

getParent

public Control getParent()

Returns the control group to which this control belongs, if any. Otherwise it returns null.

Specified by:

getParent in interface AtomicControl

Returns:

parent control

addControlChangeListener

public void addControlChangeListener(ControlChangeListener ccl)

Add a listener that should be informed if any state of this control changes.

Specified by:

addControlChangeListener in interface AtomicControl

Parameters:

ccl - listener to be added to the list of registered listeners

removeControlChangeListener

public void removeControlChangeListener(ControlChangeListener ccl)

Remove an already added listener. Does nothing if the listener was not previously added.

Specified by:

removeControlChangeListener in interface AtomicControl

Parameters:

ccl - listener to be removed from the list of registered listeners

informListeners

public void informListeners()

informs listeners about changes in control's state

getTip

public String getTip()

Sun specific - Returns the description string for this control.

Specified by:

getTip in interface AtomicControl

setTip

public void setTip(String tip)

Sun specific - Sets the description string for this control. Should be short since it will be displayed as a tool tip when the mouse hovers over the control for a few seconds.

Specified by:

setTip in interface AtomicControl

Parameters:

tip - tip string

getControlComponent

public Component getControlComponent()

returns control component associated with the control adapter

Specified by:

getControlComponent in interface Control

Returns:

control component associated with the control adapter

isReadOnly

public boolean isReadOnly()

returns whether the control is read only return true if the control is read-only

Specified by:

isReadOnly in interface AtomicControl