totalcross.ui.dialog

Class TimeBox

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Container

totalcross.ui.Window

totalcross.ui.dialog.TimeBox

public class TimeBox
extends Window

Class used to input a time from the user. Correctly handles the AM/PM depending on Settings.is24Hour.

When the window closes, a PRESSED event is sent to the caller, and the time can be retrieved using getTime. Here's a sample:

 TimeBox tb;
 
 public void initUI() {
        try {
                (tb = new TimeBox()).popupNonBlocking();
        } catch (Exception e) {
                e.printStackTrace();
        }
 }
 
 public void onEvent(Event e) {
        if (e.type == ControlEvent.PRESSED && e.target == tb)
                Vm.debug("ret: " + tb.getTime());
 }
 

The time can be entered also using the arrow keys and by typing the numbers directly.

Since:

TotalCross 1.22

See Also:

getTime()

Nested Class Summary

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
protected Radio	btAM
protected Button	btBack
protected Button	btClear
protected Button	btForw
protected Button	btOK
protected Radio	btPM
static java.lang.String	clearCaption Used in the button.
static boolean	hideIfInvalid Set to false to disable the buttons instead of hiding them if they are not a valid number to appear at the current position.
static java.lang.String	okCaption Used in the button.
protected totalcross.ui.dialog.TimeBox.Visor	visor

Fields inherited from class totalcross.ui.Window

_controlEvent, _dragEvent, _focus, _keyEvent, _mouseEvent, _multiEvent, _penEvent, androidBorderThickness, beepIfOut, blocking, borderStyle, cancelPenUp, canDrag, dragThreshold, fadeOtherWindows, fadeValue, firstFocus, flickEnabled, focusOnPenUp, footerColor, footerH, gradientTitleEndColor, gradientTitleStartColor, headerColor, highlighted, highResPrepared, HORIZONTAL_GRADIENT, ignoreEventOfType, keyHook, lastShiftY, lastSwappedContainer, mainSwapContainer, menubar, multiTouching, needsPaint, NO_BORDER, ORIENTATION_INVERTED, ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, popped, RECT_BORDER, repaintOnSwap, robot, ROUND_BORDER, rTitle, sameBackgroundColor, shiftH, shiftY, SIP_BOTTOM, SIP_HIDE, SIP_SHOW, SIP_TOP, TAB_BORDER, TAB_ONLY_BORDER, tempTitle, title, titleAlign, titleColor, titleFont, titleGap, topMost, VERTICAL_GRADIENT, zStack

Fields inherited from class totalcross.ui.Container

alwaysEraseBackground, BACKGROUND_CYLINDRIC_SHADED, BACKGROUND_SHADED, BACKGROUND_SHADED_INV, BACKGROUND_SOLID, backgroundStyle, BORDER_LOWERED, BORDER_NONE, BORDER_RAISED, BORDER_ROUNDED, BORDER_SIMPLE, BORDER_TOP, borderColor, borderRadius, children, controlFound, finishedStart, ignoreOnAddAgain, ignoreOnRemove, insets, lastH, lastScreenWidth, lastW, numChildren, started, tabOrder, tail, TRANSITION_TIME

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
TimeBox() Constructs a TimeBox with time set to midnight.
TimeBox(Time time) Constructs a TimeBox with the given time.

Method Summary

Modifier and Type	Method and Description
Time	getTime() Returns the time placed in this control, which is the time passed in the constructor (if any) updated with the hours, minutes and seconds.
void	onEvent(Event event) Called to process key, pen, control and other posted events.
void	onFontChanged() Called after a setFont
protected void	onPopup() Placeholder called imediatly before the popup began.
protected void	postUnpop() Placeholder called after the unpop is done and after the repaint of the other window.
void	reposition() Reposition this control, calling again setRect with the original parameters.
void	setBackColor(int c) Changing this method will also change the UIColors.timeboxBack attribute
void	setBackForeColors(int back, int fore) Changing this method will also change the UIColors.timeboxBack and UIColors.timeboxFore attributes
void	setForeColor(int c) Changing this method will also change the UIColors.timeboxFore attribute
void	setTime(Time time) Set the time, if it was not yet set in the constructor.

Methods inherited from class totalcross.ui.Window

_doPaint, _postEvent, destroyZStack, drawHighlight, getBorderStyle, getClientRect, getClientRect, getDefaultDragThreshold, getFocus, getHighlighted, getPopupCount, getPreferredHeight, getPreferredWidth, getTitleFont, getTopMost, handleFocusChangeKeys, isScreenShifted, isSipShown, isSipShown4D, isTopMost, isVisible, loadBehind, makeUnmovable, onClickedOutside, onRobotKey, onUnpop, paintTitle, paintWindowBackground, popup, popupMenuBar, popupNonBlocking, postPopup, postPressedEvent, pumpEvents, removeFocus, repaintActiveWindows, resize, resizeHeight, resizeWidth, screenResized, setBorderStyle, setDeviceTitle, setFocus, setGrabPenEvents, setHighlighted, setMenuBar, setOrientation, setSIP, setTitle, setTitleFont, shiftScreen, swap, swapFocus, unpop, validate

Methods inherited from class totalcross.ui.Container

add, add, add, add, add, broadcastEvent, clear, fillBackground, findChild, findNearestChild, findNextFocusControl, getBorderRadius, getChildren, getChildrenCount, getFirstChild, getFocusableControls, getInsets, incLastX, incLastY, initUI, isPressed, moveFocusToNextControl, moveFocusToNextEditable, onAddAgain, onColorsChanged, onPaint, onRemove, onSwapFinished, paintChildren, remove, removeAll, setBorderRadius, setEnabled, setFocusTraversable, setHighlighting, setInsets, setPressColor, setPressed, swapToTopmostWindow

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, isVisibleAndInside, onBoundsChanged, onWindowPaintFinished, post, postEvent, releaseScreenShot, removeEnabledStateListener, removeFocusListener, removeGridListener, removeHandler, removeHighlightListener, removeKeyListener, removeListContainerListener, removeMouseListener, removeMultiTouchListener, removePenListener, removePressListener, removePushNotificationListener, removeTimer, removeTimerListener, removeWindowListener, repaint, repaintNow, reposition, repositionChildren, requestFocus, resetSetPositions, resetStyle, safeRepaintNow, safeUpdateScreen, sendToBack, setDoEffect, setFloating, setFocusLess, setFont, 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

btOK

protected Button btOK

btClear

protected Button btClear

btBack

protected Button btBack

btForw

protected Button btForw

btAM

protected Radio btAM

btPM

protected Radio btPM

visor

protected totalcross.ui.dialog.TimeBox.Visor visor

okCaption

public static java.lang.String okCaption

Used in the button. Change it if you want to localize the text.

clearCaption

public static java.lang.String clearCaption

Used in the button. Change it if you want to localize the text.

hideIfInvalid

public static boolean hideIfInvalid

Set to false to disable the buttons instead of hiding them if they are not a valid number to appear at the current position. By default, the buttons are hidden, but setting this to false can disable them instead.

Constructor Detail

TimeBox

public TimeBox()

Constructs a TimeBox with time set to midnight.

TimeBox

public TimeBox(Time time)

Constructs a TimeBox with the given time. If the time is invalid, it is set to midnight.

Method Detail

setTime

public void setTime(Time time)

Set the time, if it was not yet set in the constructor.

onFontChanged

public void onFontChanged()

Description copied from class: Control

Called after a setFont

Overrides:

onFontChanged in class Control

onPopup

protected void onPopup()

Description copied from class: Window

Placeholder called imediatly before the popup began. The default implementation does nothing.

Overrides:

onPopup in class Window

getTime

public Time getTime()

Returns the time placed in this control, which is the time passed in the constructor (if any) updated with the hours, minutes and seconds.

reposition

public void reposition()

Description copied from class: Control

Reposition this control, calling again setRect with the original parameters.

Overrides:

reposition in class Control

setBackColor

public void setBackColor(int c)

Changing this method will also change the UIColors.timeboxBack attribute

Overrides:

setBackColor in class Control

setForeColor

public void setForeColor(int c)

Changing this method will also change the UIColors.timeboxFore attribute

Overrides:

setForeColor in class Control

setBackForeColors

public void setBackForeColors(int back,
                              int fore)

Changing this method will also change the UIColors.timeboxBack and UIColors.timeboxFore attributes

Overrides:

setBackForeColors in class Control

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

postUnpop

protected void postUnpop()

Description copied from class: Window

Placeholder called after the unpop is done and after the repaint of the other window. The default implementation does nothing.

Overrides:

postUnpop in class Window