Java DTV API 1.0
12-Dec-2008

com.sun.lwuit
Class CheckBox

java.lang.Object
  extended bycom.sun.lwuit.Component
      extended bycom.sun.dtv.ui.MatteEnabledComponent
          extended bycom.sun.dtv.ui.ViewOnlyComponent
              extended bycom.sun.lwuit.Label
                  extended bycom.sun.lwuit.Button
                      extended bycom.sun.lwuit.CheckBox
All Implemented Interfaces:
Animated, MatteEnabled, StyleListener

public class CheckBox
extends Button

Checkbox is a button that can be selected or deselected, and which displays its state to the user.


Field Summary
 
Fields inherited from class com.sun.lwuit.Button
STATE_DEFAULT, STATE_PRESSED, STATE_ROLLOVER
 
Fields inherited from class com.sun.dtv.ui.ViewOnlyComponent
HORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, SCALE_ASPECT_PROOF, SCALE_NO, SCALE_NO_ASPECT_PROOF, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_CENTER, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_TOP
 
Fields inherited from class com.sun.lwuit.Component
BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, LEFT, RIGHT, TOP
 
Fields inherited from interface com.sun.dtv.ui.Animated
ALTERNATING, LOOP, REPEATING
 
Constructor Summary
CheckBox()
          Constructs a checkbox with no text.
CheckBox(Image icon)
          Constructs a checkbox with the given icon.
CheckBox(String text)
          Constructs a checkbox with the given text.
CheckBox(String text, Image icon)
          Constructs a checkbox with the given text and icon.
 
Method Summary
protected  Dimension calcPreferredSize()
          Calculates the preferred size based on component content.
protected  String getUIID()
          Unique identifier for a component, must be overriden for a component so a style can be applied to the component.
 boolean isSelected()
          Return true if the checkbox is selected.
 void paint(Graphics g)
          Method to paint the component.
protected  String paramString()
          Returns a string representing the state of this component.
 void setSelected(boolean selected)
          Selects the current checkbox.
 
Methods inherited from class com.sun.lwuit.Button
addActionListener, fireClicked, getBorder, getPressedIcon, getRolloverIcon, getState, isSelectableInteraction, keyPressed, keyReleased, pointerPressed, pointerReleased, removeActionListener, setPressedIcon, setRolloverIcon
 
Methods inherited from class com.sun.lwuit.Label
animate, getAlignment, getBaselineResizeBehavior, getGap, getIcon, getShiftText, getText, getTextPosition, getVerticalAlignment, isEndsWith3Points, isTickerEnabled, isTickerRunning, setAlignment, setEndsWith3Points, setGap, setIcon, setShiftText, setText, setTextPosition, setTickerEnabled, setVerticalAlignment, startTicker, stopTicker
 
Methods inherited from class com.sun.dtv.ui.ViewOnlyComponent
getAnimateContent, getGraphicContent, getHorizontalAlignment, getInteractionState, getScalingMode, getTextContent, getTextLayoutManager, isOpaque, setAnimateContent, setGraphicContent, setHorizontalAlignment, setInteractionState, setScalingMode, setTextContent, setTextLayoutManager
 
Methods inherited from class com.sun.dtv.ui.MatteEnabledComponent
getMatte, isDoubleBuffered, processEvent, setMatte
 
Methods inherited from class com.sun.lwuit.Component
addFocusListener, contains, deinitialize, getAbsoluteX, getAbsoluteY, getAnimationMode, getBaseline, getBottomGap, getBounds, getClientProperty, getComponentForm, getDelay, getHeight, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getParent, getPosition, getPreferredSize, getRepetitionMode, getScrollAnimationSpeed, getScrollX, getScrollY, getSideGap, getStyle, getWidth, getX, getY, handlesInput, hasFocus, initComponent, isEnabled, isFocusable, isFocusPainted, isInitialized, isRunning, isScrollable, isScrollableX, isScrollableY, isScrollVisible, isSmoothScrolling, isVisible, jumpTo, keyRepeated, longKeyPress, paintBackground, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintScrollbars, paintScrollbarX, paintScrollbarY, pointerDragged, putClientProperty, refreshTheme, refreshTheme, removeFocusListener, repaint, repaint, requestFocus, scrollRectToVisible, setAnimationMode, setCellRenderer, setDelay, setEnabled, setFocus, setFocusable, setFocusPainted, setHandlesInput, setHeight, setInitialized, setIsScrollVisible, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setPreferredSize, setRepetitionMode, setScrollAnimationSpeed, setScrollX, setScrollY, setShouldCalcPreferredSize, setSize, setSmoothScrolling, setStyle, setVisible, setWidth, setX, setY, start, stop, styleChanged, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckBox

public CheckBox(String text)
Constructs a checkbox with the given text.

Parameters:
text - to display next to the checkbox

CheckBox

public CheckBox()
Constructs a checkbox with no text.


CheckBox

public CheckBox(Image icon)
Constructs a checkbox with the given icon.

Parameters:
icon - icon to display next to the checkbox

CheckBox

public CheckBox(String text,
                Image icon)
Constructs a checkbox with the given text and icon.

Parameters:
text - to display next to the checkbox
icon - icon to display next to the text
Method Detail

getUIID

protected String getUIID()
Description copied from class: Component
Unique identifier for a component, must be overriden for a component so a style can be applied to the component.

Overrides:
getUIID in class Button

isSelected

public boolean isSelected()
Return true if the checkbox is selected.

Returns:
true if the checkbox is selected

setSelected

public void setSelected(boolean selected)
Selects the current checkbox.

Parameters:
selected - value for selection

paint

public void paint(Graphics g)
Description copied from class: ViewOnlyComponent
Method to paint the component.

Specified by:
paint in interface Animated
Overrides:
paint in class Button

calcPreferredSize

protected Dimension calcPreferredSize()
Description copied from class: Component
Calculates the preferred size based on component content. This method is invoked lazily by getPreferred size.

Overrides:
calcPreferredSize in class Button

paramString

protected String paramString()
Description copied from class: Component
Returns a string representing the state of this component. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:
paramString in class Label

Java DTV API 1.0
12-Dec-2008

Copyright © 2008 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved.

U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Sun, Sun Microsystems, the Sun logo and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.Products covered by and information contained in this service manual are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Use of this document is subject to license terms.