totalcross.ui

Class PopupMenu

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Container

totalcross.ui.Window

totalcross.ui.PopupMenu

public class PopupMenu
extends Window

Creates a popup menu with a single line list and some radio buttons at right, like in the Android combobox styles. This is a sample of how to use it:

 String[] items = { "Always", "Never", "Only in Silent mode", "Only when not in Silent mode",
                "Non of the answers above", };
 PopupMenu pm = new PopupMenu("Vibrate", items);
 pm.popup();
 

A PRESSED event is sent when an item is selected. Note: the colors must be set before the control's bounds are defined using setRect or add.

Nested Class Summary

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cancelString The string of the button; defaults to "Cancel"
int	checkColor The check color used to fill the radio button used in Android.
int	dataCol If the items is a String matrix (String[][]), this field sets the column that will be shown.
boolean	enableCancel Set to false BEFORE popping up the window to disable the Cancel button.
boolean	enableSearch Set to true BEFORE popping up the window to enable search on the items of this PopupMenu.
int	itemCount Sets the number of elements should be used from the items array passed in the constructor.
boolean	keepIndexOnCancel Set to true to keep the selected index unchanged if user press the Cancel button

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
PopupMenu(java.lang.String caption, java.lang.Object[] items) Constructs a PopupMenu with the given parameters and without multiple selection support.
PopupMenu(java.lang.String caption, java.lang.Object[] items, boolean multipleSelection) Constructs a PopupMenu with the given parameters.

Method Summary

Modifier and Type	Method and Description
ListBox	getMenu() Returns the ListBox used to show the menu.
int	getPreferredHeight() Returns the size of the title if any plus the size of the border.
int	getPreferredWidth() Returns the size of the title if any plus the size of the border.
int	getSelectedIndex() Returns the selected index when this window was closed or -1 if non was selected
java.lang.Object	getSelectedItem()
void	initUI() Called to initialize the User Interface of this container.
boolean	onClickedOutside(PenEvent event) called when the user clicks outside the bounds of this window.
void	onEvent(Event event) Called to process key, pen, control and other posted events.
void	onPaint(Graphics g) Draws the border (if any).
protected void	onPopup() Setup some important variables
void	popupAt(int x, int y)
void	popupAt(int x, int y, int width, int height)
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	setCursorColor(int c) Sets the cursor color.
int	setSelectedIndex(int index) Selects the given index.
void	setTitle(java.lang.String title) Sets the title and call repaint.

Methods inherited from class totalcross.ui.Window

_doPaint, _postEvent, destroyZStack, drawHighlight, getBorderStyle, getClientRect, getClientRect, getDefaultDragThreshold, getFocus, getHighlighted, getPopupCount, getTitleFont, getTopMost, handleFocusChangeKeys, isScreenShifted, isSipShown, isSipShown4D, isTopMost, isVisible, loadBehind, makeUnmovable, onRobotKey, onUnpop, paintTitle, paintWindowBackground, popup, popupMenuBar, popupNonBlocking, postPopup, postPressedEvent, pumpEvents, removeFocus, repaintActiveWindows, resize, resizeHeight, resizeWidth, screenResized, setBorderStyle, setDeviceTitle, setFocus, setGrabPenEvents, setHighlighted, setMenuBar, setOrientation, setSIP, 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, isPressed, moveFocusToNextControl, moveFocusToNextEditable, onAddAgain, onColorsChanged, 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, onFontChanged, 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, setBackColor, setBackForeColors, setDoEffect, 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

cancelString

public static java.lang.String cancelString

The string of the button; defaults to "Cancel"

dataCol

public int dataCol

If the items is a String matrix (String[][]), this field sets the column that will be shown.

itemCount

public int itemCount

Sets the number of elements should be used from the items array passed in the constructor. Defaults to items.length.

checkColor

public int checkColor

The check color used to fill the radio button used in Android. Defaults to the fore color.

Since:

TotalCross 1.3

enableSearch

public boolean enableSearch

Set to true BEFORE popping up the window to enable search on the items of this PopupMenu. Note that it only works if the items are ORDERED.

Since:

TotalCross 1.5

enableCancel

public boolean enableCancel

Set to false BEFORE popping up the window to disable the Cancel button.

Since:

TotalCross 1.65

keepIndexOnCancel

public boolean keepIndexOnCancel

Set to true to keep the selected index unchanged if user press the Cancel button

Since:

TotalCross 2.0

Constructor Detail

PopupMenu

public PopupMenu(java.lang.String caption,
                 java.lang.Object[] items)
          throws IOException,
                 ImageException

Constructs a PopupMenu with the given parameters and without multiple selection support.

Throws:

IOException

ImageException

PopupMenu

public PopupMenu(java.lang.String caption,
                 java.lang.Object[] items,
                 boolean multipleSelection)
          throws IOException,
                 ImageException

Constructs a PopupMenu with the given parameters.

Throws:

IOException

ImageException

Method Detail

onClickedOutside

public boolean onClickedOutside(PenEvent event)

Description copied from class: Window

called when the user clicks outside the bounds of this window. must return true if the event was handled, false otherwise. If false is returned and beepIfOut is true, then a beep is played and nothing more happens.

Overrides:

onClickedOutside in class Window

initUI

public void initUI()

Description copied from class: Container

Called to initialize the User Interface of this container. This differs from the onAddAgain method by that this method is called only once, at the first time the control is added to the parent. When the container is being setup, the initUI method is called; then, the onAddAgain is called every time the container is added again.

Overrides:

initUI in class Container

reposition

public void reposition()

Description copied from class: Control

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

Overrides:

reposition 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

onPaint

public void onPaint(Graphics g)

Description copied from class: Container

Draws the border (if any). If you override this method, be sure to call super.onPaint(g);, or the border will not be drawn.

Overrides:

onPaint in class Container

Parameters:

g - the graphics object for drawing

See Also:

Graphics

setTitle

public void setTitle(java.lang.String title)

Description copied from class: Window

Sets the title and call repaint.

Overrides:

setTitle in class Window

getPreferredWidth

public int getPreferredWidth()

Description copied from class: Window

Returns the size of the title if any plus the size of the border. Note that the value returned here does not handle the controls inside the window.

Overrides:

getPreferredWidth in class Window

getPreferredHeight

public int getPreferredHeight()

Description copied from class: Window

Returns the size of the title if any plus the size of the border. Note that the value returned here does not handle the controls inside the window.

Overrides:

getPreferredHeight in class Window

getMenu

public ListBox getMenu()

Returns the ListBox used to show the menu. You can edit the paddings the way you want calling this method.

getSelectedItem

public java.lang.Object getSelectedItem()

setSelectedIndex

public int setSelectedIndex(int index)

Selects the given index.

getSelectedIndex

public int getSelectedIndex()

Returns the selected index when this window was closed or -1 if non was selected

popupAt

public void popupAt(int x,
                    int y,
                    int width,
                    int height)

popupAt

public void popupAt(int x,
                    int y)

onPopup

protected void onPopup()

Setup some important variables

Overrides:

onPopup in class Window

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

setCursorColor

public void setCursorColor(int c)

Sets the cursor color. By default, it is based in the background color