java.awt
クラス Checkbox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Checkbox

すべての実装インタフェース:

Accessible, ImageObserver, ItemSelectable, MenuContainer, Serializable

public class Checkbox

extends Component

implements ItemSelectable, Accessible

チェックボックスは、「オン」 (true) または「オフ」 (false) のどちらかの状態をとることができるグラフィカルコンポーネントです。チェックボックスをクリックすると、その状態を「オン」から「オフ」に、または「オフ」から「オン」に変更することができます。

次のコード例では、グリッドレイアウトにチェックボックスのセットを生成します。

setLayout(new GridLayout(3, 1));
add(new Checkbox("one", null, true));
add(new Checkbox("two"));
add(new Checkbox("three"));

このイメージは、このコード例によって作成されるチェックボックスとグリッドレイアウトを表します。

one というラベルの付いたボタンは「オン」の状態で、ほかの 2 つのボタンは「オフ」の状態です。GridLayout クラスを使用するこの例では、3 つのチェックボックスがそれぞれ独立して設定されます。

また、CheckboxGroup クラスを使って、いくつかのチェックボックスをグループ化して 1 つのオブジェクトで制御することもできます。チェックボックスグループでは、一度に 1 つのボタンだけを「オン」の状態にすることができます。1 つのチェックボックスをクリックしてオンにすると、同一グループ内のほかのチェックボックスは「オフ」の状態になります。

導入されたバージョン:

JDK1.0

関連項目:

GridLayout, CheckboxGroup, 直列化された形式

入れ子クラスの概要

protected class

Checkbox.AccessibleAWTCheckbox このクラスは Checkbox クラス用のユーザ補助機能のサポートを実装しています。

クラス java.awt.Component から継承した入れ子クラス

Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドの概要

クラス java.awt.Component から継承したフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース java.awt.image.ImageObserver から継承したフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

コンストラクタの概要

Checkbox()
ラベルなしのチェックボックスを作成します。

Checkbox(String label)
指定されたラベルが付いたチェックボックスを作成します。

Checkbox(String label, boolean state)
指定されたラベルが付いたチェックボックスを作成し、指定された状態に設定します。

Checkbox(String label, boolean state, CheckboxGroup group)
指定されたラベルが付いたチェックボックスを、指定されたチェックボックスグループに構築し、指定された状態に設定します。

Checkbox(String label, CheckboxGroup group, boolean state)
指定されたラベルが付いたチェックボックスを、指定されたチェックボックスグループに生成し、指定された状態に設定します。

メソッドの概要

void	addItemListener(ItemListener l) 指定された項目リスナーを、このチェックボックスの項目イベント受信のために追加します。
void	addNotify() チェックボックスのピアを生成します。
AccessibleContext	getAccessibleContext() この CheckBox に関連付けられた AccessibleContext を返します。
CheckboxGroup	getCheckboxGroup() このチェックボックスのグループを判定します。
ItemListener[]	getItemListeners() このチェックボックスに登録されているすべての項目リスナーの配列を返します。
String	getLabel() チェックボックスのラベルを返します。
EventListener[]	getListeners(Class listenerType) この Checkbox に FooListener として現在登録されているすべてのオブジェクトの配列を返します。
Object[]	getSelectedObjects() チェックボックスのラベルを含む配列 (長さ 1) を返します。
boolean	getState() このチェックボックスが「オン」の状態であるか、「オフ」の状態であるかを判定します。
protected String	paramString() この Checkbox の状態を表す文字列を返します。
protected void	processEvent(AWTEvent e) このチェックボックスでイベントを処理します。
protected void	processItemEvent(ItemEvent e) このチェックボックスで発生する項目イベントを、登録されている ItemListener オブジェクトにディスパッチすることにより、項目イベントを処理します。
void	removeItemListener(ItemListener l) このチェックボックスからの項目イベントを受け取らないように、指定された項目リスナーを削除します。
void	setCheckboxGroup(CheckboxGroup g) このチェックボックスのグループを、指定されたチェックボックスグループに設定します。
void	setLabel(String label) このチェックボックスのラベルを文字列引数に設定します。
void	setState(boolean state) このチェックボックスの状態を、指定された状態に設定します。

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

Checkbox

public Checkbox()
         throws HeadlessException

ラベルなしのチェックボックスを作成します。このチェックボックスの状態は「オフ」に設定され、チェックボックスグループには属しません。

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label)
         throws HeadlessException

指定されたラベルが付いたチェックボックスを作成します。このチェックボックスの状態は「オフ」に設定され、チェックボックスグループには属しません。

パラメータ:

label - このチェックボックスの文字列ラベル。ラベルがない場合は null

例外:

HeadlessException - GraphicsEnvironment.isHeadless が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label,
                boolean state)
         throws HeadlessException

指定されたラベルが付いたチェックボックスを作成し、指定された状態に設定します。このチェックボックスは、どのチェックボックスグループにも属しません。

パラメータ:

label - このチェックボックスの文字列ラベル。ラベルがない場合は null

state - このチェックボックスの初期状態

例外:

HeadlessException - GraphicsEnvironment.isHeadless が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label,
                boolean state,
                CheckboxGroup group)
         throws HeadlessException

指定されたラベルが付いたチェックボックスを、指定されたチェックボックスグループに構築し、指定された状態に設定します。

パラメータ:

label - このチェックボックスの文字列ラベル。ラベルがない場合は null

state - このチェックボックスの初期状態

group - このチェックボックスのチェックボックスグループ。グループがない場合は null

例外:

HeadlessException - GraphicsEnvironment.isHeadless が true を返す場合

導入されたバージョン:

JDK1.1

関連項目:

GraphicsEnvironment.isHeadless()

Checkbox

public Checkbox(String label,
                CheckboxGroup group,
                boolean state)
         throws HeadlessException

指定されたラベルが付いたチェックボックスを、指定されたチェックボックスグループに生成し、指定された状態に設定します。

パラメータ:

label - このチェックボックスの文字列ラベル。ラベルがない場合は null

group - このチェックボックスのチェックボックスグループ。グループがない場合は null

state - このチェックボックスの初期状態

例外:

HeadlessException - GraphicsEnvironment.isHeadless が true を返す場合

導入されたバージョン:

JDK1.1

関連項目:

GraphicsEnvironment.isHeadless()

メソッドの詳細

addNotify

public void addNotify()

チェックボックスのピアを生成します。これにより、チェックボックスの機能を変更することなく、その外観を変更することが可能になります。

オーバーライド:

クラス Component 内の addNotify

関連項目:

Toolkit.createCheckbox(java.awt.Checkbox), Component.getToolkit()

getLabel

public String getLabel()

チェックボックスのラベルを返します。

戻り値:

このチェックボックスのラベル。このチェックボックスにラベルがない場合は null

関連項目:

setLabel(java.lang.String)

setLabel

public void setLabel(String label)

このチェックボックスのラベルを文字列引数に設定します。

パラメータ:

label - 新しいラベルとして設定する文字列。ラベルがない場合は null

関連項目:

getLabel()

getState

public boolean getState()

このチェックボックスが「オン」の状態であるか、「オフ」の状態であるかを判定します。boolean 値 true は「オン」の状態を示し、false は「オフ」の状態を示します。

戻り値:

boolean 値で表されるこのチェックボックスの状態

関連項目:

setState(boolean)

setState

public void setState(boolean state)

このチェックボックスの状態を、指定された状態に設定します。boolean 値 true は「オン」の状態を示し、false は「オフ」の状態を示します。

このメソッドは、おもにチェックボックスのステータス初期化のために使用してください。チェックボックスのステータスをプログラムで設定しても ItemEvent は開始されません。ItemEvent を開始する唯一の方法はユーザの操作だけです。

パラメータ:

state - boolean 値で表したチェックボックスの状態

関連項目:

getState()

getSelectedObjects

public Object[] getSelectedObjects()

チェックボックスのラベルを含む配列 (長さ 1) を返します。チェックボックスが選択されていない場合には null を返します。

定義:

インタフェース ItemSelectable 内の getSelectedObjects

関連項目:

ItemSelectable

getCheckboxGroup

public CheckboxGroup getCheckboxGroup()

このチェックボックスのグループを判定します。

戻り値:

このチェックボックスのグループ。チェックボックスがグループに属さない場合は null

関連項目:

setCheckboxGroup(java.awt.CheckboxGroup)

setCheckboxGroup

public void setCheckboxGroup(CheckboxGroup g)

このチェックボックスのグループを、指定されたチェックボックスグループに設定します。このチェックボックスがすでにほかのチェックボックスグループにある場合は、最初にそのグループから削除されます。

パラメータ:

g - 新しいチェックボックスグループ。チェックボックスグループからこのチェックボックスを削除する場合は null

関連項目:

getCheckboxGroup()

addItemListener

public void addItemListener(ItemListener l)

指定された項目リスナーを、このチェックボックスの項目イベント受信のために追加します。項目イベントは setState() の呼び出しではなく、ユーザの入力に反応してリスナーに送信されます。l が null の場合、例外はスローされず、処理も実行されません。

定義:

インタフェース ItemSelectable 内の addItemListener

パラメータ:

l - 項目リスナー

導入されたバージョン:

JDK1.1

関連項目:

removeItemListener(java.awt.event.ItemListener), getItemListeners(), setState(boolean), ItemEvent, ItemListener

removeItemListener

public void removeItemListener(ItemListener l)

このチェックボックスからの項目イベントを受け取らないように、指定された項目リスナーを削除します。l が null の場合、例外はスローされず、処理も実行されません。

定義:

インタフェース ItemSelectable 内の removeItemListener

パラメータ:

l - 項目リスナー

導入されたバージョン:

JDK1.1

関連項目:

addItemListener(java.awt.event.ItemListener), getItemListeners(), ItemEvent, ItemListener

getItemListeners

public ItemListener[] getItemListeners()

このチェックボックスに登録されているすべての項目リスナーの配列を返します。

戻り値:

このチェックボックスのすべての ItemListener。項目リスナーが現在登録されていない場合は空の配列を返す

導入されたバージョン:

1.4

関連項目:

addItemListener(java.awt.event.ItemListener), removeItemListener(java.awt.event.ItemListener), ItemEvent, ItemListener

getListeners

public EventListener[] getListeners(Class listenerType)

この Checkbox に FooListener として現在登録されているすべてのオブジェクトの配列を返します。この FooListener は addFooListener メソッドで登録されたものです。

listenerType 引数は FooListener.class のようなクラスリテラルで指定できます。たとえば、この項目リスナーに対する Checkbox c の照会は次のコードで行います。

ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));

このようなリスナーがない場合は空の配列を返します。

オーバーライド:

クラス Component 内の getListeners

パラメータ:

listenerType - 要求されるリスナーのタイプ。java.util.EventListener の下位インタフェースを指定

戻り値:

このチェックボックスに FooListener として登録されているすべてのオブジェクトの配列。リスナーが登録されていない場合は空の配列を返す

例外:

ClassCastException - listenerType が java.util.EventListener を実装するクラスまたはインタフェースを指定しない場合

導入されたバージョン:

1.3

関連項目:

getItemListeners()

processEvent

protected void processEvent(AWTEvent e)

このチェックボックスでイベントを処理します。イベントが ItemEvent のインスタンスである場合、このメソッドは processItemEvent メソッドを呼び出します。そうでない場合は、スーパークラスの processEvent メソッドを呼び出します。

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

オーバーライド:

クラス Component 内の processEvent

パラメータ:

e - イベント

導入されたバージョン:

JDK1.1

関連項目:

ItemEvent, processItemEvent(java.awt.event.ItemEvent)

processItemEvent

protected void processItemEvent(ItemEvent e)

このチェックボックスで発生する項目イベントを、登録されている ItemListener オブジェクトにディスパッチすることにより、項目イベントを処理します。

項目イベントがこのコンポーネント用に使用可能になっていないかぎり、このメソッドは呼び出されません。項目イベントは、以下のどれかが発生したときに使用可能になります。

• ItemListener オブジェクトが addItemListener を使って登録される
• enableEvents によって項目イベントが使用可能になる

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

パラメータ:

e - 項目イベント

導入されたバージョン:

JDK1.1

関連項目:

ItemEvent, ItemListener, addItemListener(java.awt.event.ItemListener), Component.enableEvents(long)

paramString

protected String paramString()

この Checkbox の状態を表す文字列を返します。このメソッドは、デバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空白の場合がありますが、null にはなりません。

オーバーライド:

クラス Component 内の paramString

戻り値:

このチェックボックスのパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()

この CheckBox に関連付けられた AccessibleContext を返します。CheckBox の場合、AccessibleContext は AccessibleAWTCheckBox の形式を取ります。必要に応じて新規の AccessibleAWTChecBox が生成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス Component 内の getAccessibleContext

戻り値:

この Checkbox の AccessibleContext として機能する AccessibleAWTCheckbox