totalcross.ui

Class Check

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Check

All Implemented Interfaces:

MaterialEffect.SideEffect, TextControl

public class Check
extends Control
implements TextControl, MaterialEffect.SideEffect

Check is a control with a box and a check inside of it when the state is checked.

Here is an example showing a check being used:

 public class MyProgram extends MainWindow
 {
    Check check;

    public void initUI()
    {
       add(check = new Check("Check me"), LEFT, AFTER);
    }

    public void onEvent(Event event)
    {
       if (event.type == ControlEvent.PRESSED && event.target == check)
       {
          bool checked = check.isChecked();
          ... handle check being pressed
 

Nested Class Summary

Nested classes/interfaces inherited from class totalcross.ui.Control

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autoSplit Set to true to let the Check split its text based on the width every time its width changes.
int	checkColor Set to the color of the check, if you want to make it different of the foreground color.
int	checkSize Sets the size of the check.
int	disabledColor The disable color used to fill the background color when disabled.
boolean	leftJustify Deprecated. Now the align is always at left
int	textColor Sets the text color of the check.
int	textLeftGap Change to modify the gap value between the checkbox and the text.

Fields inherited from class totalcross.ui.Control

AFTER, alphaValue, appId, appObj, asContainer, asWindow, backColor, BEFORE, BOTTOM, BOTTOM_OF, BRIGHTER_BACKGROUND, callListenersOnAllTargets, CENTER, CENTER_OF, clearValueInt, clearValueStr, DARKER_BACKGROUND, DP, effect, enableUpdateScreen, esce, eventsEnabled, FILL, fillColor, FIT, floating, fm, fmH, focusHandler, focusLess, focusOnPenDown, focusTraversable, font, FONTSIZE, foreColor, height, ignoreInsets, isHighlighting, isTablet, KEEP, keepDisabled, keepEnabled, LEFT, next, nextTabControl, npParts, offscreen, offscreen0, onEventFirst, parent, PARENTSIZE, PARENTSIZEMAX, PARENTSIZEMIN, PREFERRED, prev, RANGE, repositionAllowed, RIGHT, RIGHT_OF, SAME, SCREENSIZE, SCREENSIZEMAX, SCREENSIZEMIN, setFont, setH, setRel, setW, setX, SETX_NOT_SET, setY, tempW, textShadowColor, TOP, translucentShape, transparentBackground, uiAdjustmentsBasedOnFontHeightIsSupported, uiAndroid, UICONST, uiFlat, uiHolo, uiMaterial, uiVista, visible, width, WILL_RESIZE, x, y

Constructor Summary

Constructors

Constructor and Description
Check() Creates a check control.
Check(java.lang.String text) Creates a check control displaying the given text.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this control, checking it if clearValueInt is 1.
int	getMaxTextWidth() Returns the maximum text width for the lines of this Label.
int	getPreferredHeight() Returns the preferred height of this control.
int	getPreferredWidth() Returns the preferred width of this control.
java.lang.String	getText() Gets the text displayed in the check.
boolean	isChecked() Returns the checked state of the control.
protected void	onBoundsChanged(boolean screenChanged) Called after a setRect.
protected void	onColorsChanged(boolean colorsChanged) Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container.
void	onEvent(Event event) Called by the system to pass events to the check control.
protected void	onFontChanged() Called after a setFont
void	onPaint(Graphics g) Called by the system to draw the check control.
static void	paintCheck(Graphics g, int fmH, int height) Paints a check in the given coordinates.
void	setChecked(boolean checked) Sets the checked state of the control.
void	setChecked(boolean checked, boolean sendPress) Sets the checked state of the control, and send the press event if desired.
void	setInsets(int left, int right, int top, int bottom) Modify the check insets.
void	setText(java.lang.String text) Sets the text that is displayed in the check.
void	sidePaint(Graphics g, int alpha)
void	sideStart()
void	sideStop()
void	split(int maxWidth) Splits the text to the given width.

Methods inherited from class totalcross.ui.Control

_onEvent, addEnabledStateListener, addFocusListener, addFontChangeHandler, addGridListener, addHandler, addHighlightListener, addKeyListener, addListContainerListener, addMouseListener, addMultiTouchListener, addPenListener, addPressListener, addPushNotificationListener, addSizeChangeHandler, addTimer, addTimer, addTimerListener, addValueChangeHandler, addWindowListener, bringToFront, changeHighlighted, contains, drawTranslucentBackground, getAbsoluteRect, getBackColor, getDoEffect, getEffectH, getEffectW, getEffectX, getEffectY, getEventListeners, getFont, getForeColor, getGap, getGraphics, getHeight, getNext, getParent, getParentWindow, getPos, getPressedEvent, getPrev, getRect, getSize, getTextShadowColor, getWidth, getX, getX2, getY, getY2, hadParentScrolled, handleGeographicalFocusChangeKeys, hasFocus, internalSetEnabled, intXYWH, isActionEvent, isChildOf, isDisplayed, isEnabled, isFloating, isInsideOrNear, isObscured, isTopMost, isVisible, isVisibleAndInside, onWindowPaintFinished, post, postEvent, postPressedEvent, releaseScreenShot, removeEnabledStateListener, removeFocusListener, removeGridListener, removeHandler, removeHighlightListener, removeKeyListener, removeListContainerListener, removeMouseListener, removeMultiTouchListener, removePenListener, removePressListener, removePushNotificationListener, removeTimer, removeTimerListener, removeWindowListener, repaint, repaintNow, reposition, reposition, repositionChildren, requestFocus, resetSetPositions, resetStyle, safeRepaintNow, safeUpdateScreen, sendToBack, setBackColor, setBackForeColors, setDoEffect, setEnabled, setFloating, setFocusLess, setFont, setForeColor, setNinePatch, setNinePatch, setRect, setRect, setRect, setRect, setSet, setTextShadowColor, setTranslucent, setVisible, showTip, takeInitialScreenShot, takeScreenShot, translateFromOrigin, uiStyleChanged, updateScreen, updateTemporary, willOpenKeyboard

Methods inherited from class java.lang.Object

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

Field Detail

leftJustify

@Deprecated
public boolean leftJustify

Deprecated. Now the align is always at left

Set to true to left-justify the text in the control. The default is right-justified, if the control's width is greater than the preferred one.

Since:

TotalCross 1.0

textColor

public int textColor

Sets the text color of the check. Defaults to the foreground color.

Since:

TotalCross 2.0.

checkColor

public int checkColor

Set to the color of the check, if you want to make it different of the foreground color.

Since:

TotalCross 1.3

disabledColor

public int disabledColor

The disable color used to fill the background color when disabled.

Since:

TotalCross 5.0

autoSplit

public boolean autoSplit

Set to true to let the Check split its text based on the width every time its width changes. If the height is PREFERRED, the Label will change its size accordingly. You may change the height again calling setRect.

Since:

TotalCross 1.14

textLeftGap

public int textLeftGap

Change to modify the gap value between the checkbox and the text. Tip: Use "UnitsConverter.toPixels(textLeftGap + DP) to set the size in DP.

Since:

TotalCross 5.0

checkSize

public int checkSize

Sets the size of the check. Changing its value will only have effect if the variable "autoResizeCheckSize" is false.

Since:

TotalCross 5.0

Constructor Detail

Check

public Check()

Creates a check control. The size is controlled by the height of the element. You can change it by using the "setRect" or "add" methods.

Check

public Check(java.lang.String text)

Creates a check control displaying the given text. The size is controlled by the height of the element. You can change it by using the "setRect" or "add" methods.

Method Detail

setInsets

public void setInsets(int left,
                      int right,
                      int top,
                      int bottom)

Modify the check insets.

onEvent

public void onEvent(Event event)

Called by the system to pass events to the check control.

Overrides:

onEvent in class Control

Parameters:

event - the event to process

See Also:

Event, KeyEvent, PenEvent

setText

public void setText(java.lang.String text)

Sets the text that is displayed in the check.

Specified by:

setText in interface TextControl

getText

public java.lang.String getText()

Gets the text displayed in the check.

Specified by:

getText in interface TextControl

isChecked

public boolean isChecked()

Returns the checked state of the control.

setChecked

public void setChecked(boolean checked)

Sets the checked state of the control.

setChecked

public void setChecked(boolean checked,
                       boolean sendPress)

Sets the checked state of the control, and send the press event if desired.

getMaxTextWidth

public int getMaxTextWidth()

Returns the maximum text width for the lines of this Label.

getPreferredWidth

public int getPreferredWidth()

Returns the preferred width of this control.

Overrides:

getPreferredWidth in class Control

getPreferredHeight

public int getPreferredHeight()

Returns the preferred height of this control.

Overrides:

getPreferredHeight in class Control

onColorsChanged

protected void onColorsChanged(boolean colorsChanged)

Description copied from class: Control

Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container. If colorsChanged is true, it was called from setForeColor/setBackColor/Container.add; otherwise, it was called from setEnabled

Overrides:

onColorsChanged in class Control

onPaint

public void onPaint(Graphics g)

Called by the system to draw the check control.

Overrides:

onPaint in class Control

Parameters:

g - the graphics object for drawing

See Also:

Graphics

paintCheck

public static void paintCheck(Graphics g,
                              int fmH,
                              int height)

Paints a check in the given coordinates. The g must have been translated to destination x,y coordinates.

Parameters:

g - The desired Graphics object where to paint. The forecolor must already be set.

fmH - The fmH member

height - The height of the control. The check will be vertical aligned based on this height.

Since:

SuperWaba 5.5

clear

public void clear()

Clears this control, checking it if clearValueInt is 1.

Overrides:

clear in class Control

split

public void split(int maxWidth)

Splits the text to the given width. Remember to set the font (or add the Label to its parent) before calling this method.

Since:

TotalCross 1.14

See Also:

autoSplit

onFontChanged

protected void onFontChanged()

Description copied from class: Control

Called after a setFont

Overrides:

onFontChanged in class Control

onBoundsChanged

protected void onBoundsChanged(boolean screenChanged)

Description copied from class: Control

Called after a setRect.

Overrides:

onBoundsChanged in class Control

Parameters:

screenChanged - If the bounds were changed due to a screen change (rotation, collapse)

sideStart

public void sideStart()

Specified by:

sideStart in interface MaterialEffect.SideEffect

sideStop

public void sideStop()

Specified by:

sideStop in interface MaterialEffect.SideEffect

sidePaint

public void sidePaint(Graphics g,
                      int alpha)

Specified by:

sidePaint in interface MaterialEffect.SideEffect