Package totalcross.ui

Class Switch

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Switch

All Implemented Interfaces:

ControlAnimation.AnimationFinished, PathAnimation.SetPosition

public class Switch
extends Control
implements PathAnimation.SetPosition, ControlAnimation.AnimationFinished

This class implements the on/off switch present in many platforms

Nested Class Summary

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field	Description
static int	ANIMATION_TIME	The animation time.
boolean	centerText	Set to true to center text instead of moving it to left or right
int	colorBackOff	Text color to draw when on background or foreground, and when this switch is on or off
int	colorBackOn	Text color to draw when on background or foreground, and when this switch is on or off
int	colorBallOff	Colors used in material
int	colorBallOn	Colors used in material
int	colorBarOff	Colors used in material
int	colorBarOn	Colors used in material
int	colorForeOff	Text color to draw when on background or foreground, and when this switch is on or off
int	colorForeOn	Text color to draw when on background or foreground, and when this switch is on or off
java.lang.String	textBackOff	Text to draw when on background or foreground, and when this switch is on or off
java.lang.String	textBackOn	Text to draw when on background or foreground, and when this switch is on or off
java.lang.String	textForeOff	Text to draw when on background or foreground, and when this switch is on or off
java.lang.String	textForeOn	Text to draw when on background or foreground, and when this switch is on or off

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, effect, enableUpdateScreen, esce, eventsEnabled, FILL, fillColor, FIT, fm, fmH, focusHandler, focusLess, focusOnPenDown, focusTraversable, font, FONTSIZE, foreColor, height, ignoreInsets, isHighlighting, isTablet, KEEP, keepDisabled, keepEnabled, LEFT, nextTabControl, offscreen, offscreen0, onEventFirst, parent, PARENTSIZE, PARENTSIZEMAX, PARENTSIZEMIN, PREFERRED, RANGE, repositionAllowed, RIGHT, RIGHT_OF, SAME, SCREENSIZE, SCREENSIZEMAX, SCREENSIZEMIN, setFont, setH, setRel, setW, setX, setY, tempW, textShadowColor, TOP, translucentShape, transparentBackground, uiAdjustmentsBasedOnFontHeightIsSupported, uiAndroid, UICONST, uiFlat, uiHolo, uiMaterial, uiVista, visible, width, WILL_RESIZE, x, y

Constructor Summary

Constructors

Constructor	Description
Switch()	Constructs a switch of iOS type.
Switch(boolean androidType)	Constructs a switch of the given type.

Method Summary

Modifier and Type	Method	Description
int	getPreferredHeight()	Returns the preferred height of this control.
int	getPreferredWidth()	Returns the preferred width of this control.
boolean	isOn()	Returns true if this switch is ON.
void	moveSwitch(boolean toLeft)
void	onAnimationFinished(ControlAnimation anim)
void	onBoundsChanged(boolean b)	Called after a setRect.
void	onColorsChanged(boolean b)	Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container.
void	onEvent(Event event)	Called to process key, pen, control and other posted events.
void	onPaint(Graphics g)	Called to draw the control.
void	setOn(boolean b)	Change the on/off state.
void	setPos(int x, int y)	Used by animation

Methods inherited from class totalcross.ui.Control

_onEvent, addEnabledStateListener, addFocusListener, addGridListener, addHighlightListener, addKeyListener, addListContainerListener, addMouseListener, addMultiTouchListener, addPenListener, addPressListener, addPushNotificationListener, addTimer, addTimer, addTimerListener, addWindowListener, bringToFront, changeHighlighted, clear, contains, drawTranslucentBackground, getAbsoluteRect, getBackColor, 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, isInsideOrNear, isObscured, isTopMost, isVisible, isVisibleAndInside, onFontChanged, onWindowPaintFinished, post, postEvent, postPressedEvent, releaseScreenShot, removeEnabledStateListener, removeFocusListener, removeGridListener, removeHighlightListener, removeKeyListener, removeListContainerListener, removeMouseListener, removeMultiTouchListener, removePenListener, removePressListener, removePushNotificationListener, removeTimer, removeTimerListener, removeWindowListener, repaint, repaintNow, reposition, reposition, repositionChildren, requestFocus, resetSetPositions, safeRepaintNow, safeUpdateScreen, sendToBack, setBackColor, setBackForeColors, setEnabled, setFocusLess, setFont, setForeColor, 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

ANIMATION_TIME

public static int ANIMATION_TIME

The animation time. Set to 0 to disable animations in all Switches.

textBackOn

public java.lang.String textBackOn

Text to draw when on background or foreground, and when this switch is on or off

textForeOn

public java.lang.String textForeOn

Text to draw when on background or foreground, and when this switch is on or off

textBackOff

public java.lang.String textBackOff

Text to draw when on background or foreground, and when this switch is on or off

textForeOff

public java.lang.String textForeOff

Text to draw when on background or foreground, and when this switch is on or off

colorBackOn

public int colorBackOn

Text color to draw when on background or foreground, and when this switch is on or off

colorForeOn

public int colorForeOn

Text color to draw when on background or foreground, and when this switch is on or off

colorBackOff

public int colorBackOff

Text color to draw when on background or foreground, and when this switch is on or off

colorForeOff

public int colorForeOff

Text color to draw when on background or foreground, and when this switch is on or off

colorBallOn

public int colorBallOn

Colors used in material

colorBallOff

public int colorBallOff

Colors used in material

colorBarOn

public int colorBarOn

Colors used in material

colorBarOff

public int colorBarOff

Colors used in material

centerText

public boolean centerText

Set to true to center text instead of moving it to left or right

Constructor Detail

Switch

public Switch()

Constructs a switch of iOS type. In material UI, there is only one type

Switch

public Switch(boolean androidType)

Constructs a switch of the given type. In material UI, there is only one type

Method Detail

onBoundsChanged

public void onBoundsChanged(boolean b)

Description copied from class: Control

Called after a setRect.

Overrides:

onBoundsChanged in class Control

Parameters:

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

onColorsChanged

public void onColorsChanged(boolean b)

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

setOn

public void setOn(boolean b)

Change the on/off state.

isOn

public boolean isOn()

Returns true if this switch is ON. Note that, if this Switch has animations, you must call this method only after the animation finishes

moveSwitch

public void moveSwitch(boolean toLeft)

setPos

public void setPos(int x,
                   int y)

Used by animation

Specified by:

setPos in interface PathAnimation.SetPosition

onPaint

public void onPaint(Graphics g)

Description copied from class: Control

Called to draw the control. When this method is called, the graphics object passed has been translated into the coordinate system of the control and the area behind the control has already been painted.

Overrides:

onPaint in class Control

Parameters:

g - the graphics object for drawing

See Also:

Graphics

onEvent

public void onEvent(Event event)

Description copied from class: Control

Called to process key, pen, control and other posted events.

Overrides:

onEvent in class Control

Parameters:

event - the event to process

See Also:

Event, KeyEvent, PenEvent

getPreferredHeight

public int getPreferredHeight()

Description copied from class: Control

Returns the preferred height of this control.

Overrides:

getPreferredHeight in class Control

getPreferredWidth

public int getPreferredWidth()

Description copied from class: Control

Returns the preferred width of this control.

Overrides:

getPreferredWidth in class Control

onAnimationFinished

public void onAnimationFinished(ControlAnimation anim)

Specified by:

onAnimationFinished in interface ControlAnimation.AnimationFinished