java::awt::ItemCheckable Class Reference

Inheritance diagram for java::awt::ItemCheckable:

Inheritance graph
java::awt::Checkboxjava::awt::CheckboxMenuItemjava::lang::Syncjava::awt::event::ItemSourcejava::lang::Lockjava::lang::ScopeAdapterjava::lang::Interfacejava::util::EventSourcejava::awt::ItemSelectablejava::lang::Object
[legend]
Collaboration diagram for java::awt::ItemCheckable:

Collaboration graph
java::lang::Syncjava::awt::event::ItemSourcejava::lang::Lockjava::lang::ScopeAdapterjava::lang::Interfacejava::lang::Comparablejava::util::EventSourcejava::util::Collectionjava::awt::ItemSelectablejava::lang::Objectjava::lang::ObjectRefjava::util::LinkedListjava::util::AbstractSequentialListjava::util::AbstractListjava::util::AbstractCollectionjava::util::List
[legend]

List of all members.


Detailed Description

The interface for objects which contain an item for which can be checked or unchecked.

Version:
1.15 01/23/03
Author:
Yuh-Jye Chang

Public Member Functions

 ItemCheckable (jboolean state, const Ref< CheckboxGroup > &group)
virtual jboolean getState () const
 Determines whether this check box is in the "on" or "off" state.
virtual void setState (jboolean state)
 Sets the state of this check box to the specified state.
virtual Ref
< CheckboxGroup
getCheckboxGroup () const
 Determines this check box's group.
virtual void setCheckboxGroup (Ref< CheckboxGroup > &g)
 Sets this check box's group to be the specified check box group.

Protected Attributes

jboolean state
 The state of the ItemCheckable.
Ref< CheckboxGroupgroup
 The check box group.

Constructor & Destructor Documentation

java::awt::ItemCheckable::ItemCheckable ( jboolean  state,
const Ref< CheckboxGroup > &  group 
)


Member Function Documentation

virtual jboolean java::awt::ItemCheckable::getState (  )  const [virtual]

Determines whether this check box is in the "on" or "off" state.

The boolean value true indicates the "on" state, and false indicates the "off" state.

Returns:
the state of this check box, as a boolean value
See also:
setState

virtual void java::awt::ItemCheckable::setState ( jboolean  state  )  [virtual]

Sets the state of this check box to the specified state.

The boolean value true indicates the "on" state, and false indicates the "off" state.

Parameters:
state the boolean state of the check box
See also:
getState

Reimplemented in java::awt::Checkbox, and java::awt::CheckboxMenuItem.

virtual Ref<CheckboxGroup> java::awt::ItemCheckable::getCheckboxGroup (  )  const [virtual]

Determines this check box's group.

Returns:
this check box's group, or null if the check box is not part of a check box group.
See also:
setCheckboxGroup(CheckboxGroup)

virtual void java::awt::ItemCheckable::setCheckboxGroup ( Ref< CheckboxGroup > &  g  )  [virtual]

Sets this check box's group to be the specified check box group.

If this check box is already in a different check box group, it is first taken out of that group. If the state of this check box is true and the new group already has a check box selected, this check box's state is changed to false.

Parameters:
g the new check box group, or null to remove this check box from any check box group.
See also:
getCheckboxGroup

Reimplemented in java::awt::Checkbox.


Member Data Documentation

jboolean java::awt::ItemCheckable::state [protected]

The state of the ItemCheckable.

See also:
getState()

setState(state)

Ref<CheckboxGroup> java::awt::ItemCheckable::group [protected]

The check box group.

This field can be null indicating that item checkable is not a group checkbox.

See also:
getCheckboxGroup()

setCheckboxGroup(CheckboxGroup)


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:02 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3