Package totalcross.ui.dialog

Class ControlBox

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Container

totalcross.ui.Window

totalcross.ui.dialog.ControlBox

public class ControlBox
extends Window

A popup window that displays any Control, given as parameter to the constructor.

Nested Class Summary

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field	Description
int[]	buttonKeys	If you set the buttonCaptions array in the construction, you can also set this public field to an int array of the keys that maps to each of the buttons.
protected Control	cb
protected Label	msg
protected int	prefH
protected int	prefW
int	yPosition	Defines the y position on screen where this window opens.

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, children, controlFound, finishedStart, ignoreOnAddAgain, ignoreOnRemove, insets, lastH, lastScreenWidth, lastW, started, tabOrder, tail, TRANSITION_CLOSE, TRANSITION_FADE, TRANSITION_NONE, TRANSITION_OPEN, TRANSITION_TIME, transitionEffect

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
ControlBox(java.lang.String title, java.lang.String text, Control cb)	Constructs a ControlBox with the given parameters, and an Ok and a Cancel buttons.
ControlBox(java.lang.String title, java.lang.String text, Control cb, int prefW, int prefH, java.lang.String[] buttonCaptions)	Constructs a ControlBox with the given parameters.
ControlBox(java.lang.String title, java.lang.String text, Control cb, int prefW, int prefH, java.lang.String[] buttonCaptions, int buttonRows)	Constructs a ControlBox with the given parameters.
ControlBox(java.lang.String title, java.lang.String text, Control cb, java.lang.String[] buttonCaptions)	Constructs a ControlBox with the given parameters.

Method Summary

Modifier and Type	Method	Description
Control	getControl()	returns the control associated
int	getPressedButtonIndex()	Returns the pressed button index, starting from 0
void	onEvent(Event e)	handle scroll buttons and normal buttons
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.

Methods inherited from class totalcross.ui.Window

_doPaint, _postEvent, destroyZStack, drawHighlight, fillBackground, getBorderStyle, getClientRect, getClientRect, getDefaultDragThreshold, getFocus, getHighlighted, getPopupCount, getPreferredHeight, getPreferredWidth, getSafeAreaInsets, 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, applyTransitionEffect, broadcastEvent, clear, findChild, findNearestChild, findNextFocusControl, getChildren, getChildrenCount, getFirstChild, getFocusableControls, getInsets, incLastX, incLastY, initUI, isPressed, moveFocusToNextControl, moveFocusToNextEditable, onAddAgain, onColorsChanged, onPaint, onRemove, onSwapFinished, paintChildren, remove, removeAll, setEnabled, setFocusTraversable, setHighlighting, setInsets, setNextTransitionEffect, setPressColor, setPressed, swapToTopmostWindow

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, 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, isVisibleAndInside, onBoundsChanged, onFontChanged, onWindowPaintFinished, post, postEvent, 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, 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

msg

protected Label msg

cb

protected Control cb

prefW

protected int prefW

prefH

protected int prefH

yPosition

public int yPosition

Defines the y position on screen where this window opens. Can be changed to TOP or BOTTOM. Defaults to CENTER.

See Also:

Control.CENTER, Control.TOP, Control.BOTTOM

buttonKeys

public int[] buttonKeys

If you set the buttonCaptions array in the construction, you can also set this public field to an int array of the keys that maps to each of the buttons. For example, if you set the buttons to {"Ok","Cancel"}, you can map the enter key for the Ok button and the escape key for the Cancel button by assigning:

 buttonKeys = new int[]{SpecialKeys.ENTER,SpecialKeys.ESCAPE};
 

Note that if you use the default Ok/Cancel buttons, this mapping is already done.

Since:

TotalCross 1.27

Constructor Detail

ControlBox

public ControlBox(java.lang.String title,
                  java.lang.String text,
                  Control cb)

Constructs a ControlBox with the given parameters, and an Ok and a Cancel buttons. The control may have at least one item, which will be used to determine the preferred size.

Parameters:

title - The window's title.

text - The text that will be displayed in a Label above the control.

cb - The control that will be used to get input from the user.

ControlBox

public ControlBox(java.lang.String title,
                  java.lang.String text,
                  Control cb,
                  java.lang.String[] buttonCaptions)

Constructs a ControlBox with the given parameters. The control may have at least one item, which will be used to determine the preferred size.

Parameters:

title - The window's title.

text - The text that will be displayed in a Label above the control.

cb - The control that will be used to get input from the user.

buttonCaptions - The button captions that will be used in the PushButtonGroup.

ControlBox

public ControlBox(java.lang.String title,
                  java.lang.String text,
                  Control cb,
                  int prefW,
                  int prefH,
                  java.lang.String[] buttonCaptions)

Constructs a ControlBox with the given parameters. The control may have at least one item, which will be used to determine the preferred size.

Parameters:

title - The window's title.

text - The text that will be displayed in a Label above the control.

cb - The control that will be used to get input from the user.

buttonCaptions - The button captions that will be used in the PushButtonGroup, or null to hide them.

prefW - The preferred width for the control. You can also use FILL or PREFERREED

prefH - The preferred height for the control.

ControlBox

public ControlBox(java.lang.String title,
                  java.lang.String text,
                  Control cb,
                  int prefW,
                  int prefH,
                  java.lang.String[] buttonCaptions,
                  int buttonRows)

Constructs a ControlBox with the given parameters. The control may have at least one item, which will be used to determine the preferred size.

Parameters:

title - The window's title.

text - The text that will be displayed in a Label above the control.

cb - The control that will be used to get input from the user.

buttonCaptions - The button captions that will be used in the PushButtonGroup, or null to hide them.

prefW - The preferred width for the control. You can also use FILL or PREFERREED

prefH - The preferred height for the control.

buttonRows - The number of rows for the buttons.

Method Detail

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

onEvent

public void onEvent(Event e)

handle scroll buttons and normal buttons

Overrides:

onEvent in class Control

Parameters:

e - the event to process

See Also:

Event, KeyEvent, PenEvent

getPressedButtonIndex

public int getPressedButtonIndex()

Returns the pressed button index, starting from 0

getControl

public Control getControl()

returns the control associated

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