totalcross.ui

Class TopMenu

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Container

totalcross.ui.Window

totalcross.ui.TopMenu

public class TopMenu
extends Window

This is a top menu like those on Android. It opens and closes using animation and fading effects.

Since:

TotalCross 3.03

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TopMenu.AnimationListener
static class	TopMenu.Item

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autoClose Set to false to disable the close when pressing in a button of the menu.
Image	backImage An optional image to be used as background
int	backImageAlpha The alpha value to be applied to the background image
boolean	drawSeparators
Container	header
double	itemHeightFactor
protected Control[]	items
static int	percCap The percentage of the area used for the icon and the caption
static int	percIcon The percentage of the area used for the icon and the caption
int	percWidth The percentage of the screen that this TopMenu will take: LEFT/RIGHT will take 50% of the screen's width, other directions will take 80% of the screen's width.
Insets	scInsets Insets used to place the ScrollContainer.
protected int	selected
int	separatorColor
boolean	showElevation
int	totalTime Defines the animation delay
int	widthInPixels The width in pixels instead of percentage of screen's width.

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
TopMenu(Control[] items, int animDir)
TopMenu(Control[] items, int animDir, byte borderStyle)

Method Summary

Modifier and Type	Method and Description
int	getSelectedIndex()
void	initUI() Called to initialize the User Interface of this container.
boolean	isFadeOnPopAndUnpop() Returns if this control fades in/out on pop/unpop
protected boolean	onClickedOutside(PenEvent event) called when the user clicks outside the bounds of this window.
void	onEvent(Event e) Called to process key, pen, control and other posted events.
void	onPopup() Placeholder called imediatly before the popup began.
void	popup() Pops up this window, blocking the execution until the window closes.
protected void	postPopup() Placeholder called after the popup is done and after the repaint of this window.
void	postUnpop() Placeholder called after the unpop is done and after the repaint of the other window.
void	screenResized() Called when the screen is resized, probably caused by a rotation.
void	setFadeOnPopAndUnpop(boolean fadeOnPopAndUnpop) sets if this control fades in/out on pop/unpop
protected void	setRect(boolean screenResized)
void	unpop() Unpops the current TopMenu
void	unpop(TopMenu.AnimationListener alist) Unpops the current TopMenu with the given animation listener.

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, onRobotKey, onUnpop, paintTitle, paintWindowBackground, popupMenuBar, popupNonBlocking, postPressedEvent, pumpEvents, removeFocus, repaintActiveWindows, resize, resizeHeight, resizeWidth, setBorderStyle, setDeviceTitle, setFocus, setGrabPenEvents, setHighlighted, setMenuBar, setOrientation, setSIP, setTitle, setTitleFont, shiftScreen, swap, swapFocus, 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, 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, onFontChanged, onWindowPaintFinished, post, postEvent, 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, 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

percIcon

public static int percIcon

The percentage of the area used for the icon and the caption

percCap

public static int percCap

The percentage of the area used for the icon and the caption

items

protected Control[] items

selected

protected int selected

autoClose

public boolean autoClose

Set to false to disable the close when pressing in a button of the menu.

totalTime

public int totalTime

Defines the animation delay

percWidth

public int percWidth

The percentage of the screen that this TopMenu will take: LEFT/RIGHT will take 50% of the screen's width, other directions will take 80% of the screen's width. Must be ser before calling popup().

widthInPixels

public int widthInPixels

The width in pixels instead of percentage of screen's width.

backImage

public Image backImage

An optional image to be used as background

backImageAlpha

public int backImageAlpha

The alpha value to be applied to the background image

scInsets

public Insets scInsets

Insets used to place the ScrollContainer.

drawSeparators

public boolean drawSeparators

separatorColor

public int separatorColor

showElevation

public boolean showElevation

itemHeightFactor

public double itemHeightFactor

header

public Container header

Constructor Detail

TopMenu

public TopMenu(Control[] items,
               int animDir,
               byte borderStyle)

Parameters:

animDir - LEFT, RIGHT, TOP, BOTTOM, CENTER

TopMenu

public TopMenu(Control[] items,
               int animDir)

Parameters:

animDir - LEFT, RIGHT, TOP, BOTTOM, CENTER

Method Detail

popup

public void popup()

Description copied from class: Window

Pops up this window, blocking the execution until the window closes.

Overrides:

popup in class Window

setRect

protected void setRect(boolean screenResized)

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

onEvent

public void onEvent(Event e)

Description copied from class: Control

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

Overrides:

onEvent in class Control

Parameters:

e - the event to process

See Also:

Event, KeyEvent, PenEvent

screenResized

public void screenResized()

Description copied from class: Window

Called when the screen is resized, probably caused by a rotation. ATTENTION: THIS CALL CANNOT BE BLOCKED OR THE SYSTEM WILL LOCK!

Overrides:

screenResized in class Window

onClickedOutside

protected 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

unpop

public void unpop()

Unpops the current TopMenu

Overrides:

unpop in class Window

unpop

public void unpop(TopMenu.AnimationListener alist)

Unpops the current TopMenu with the given animation listener. This listener will be notified when the unpop animation ends.

Parameters:

alist -

postUnpop

public 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

onPopup

public void onPopup()

Description copied from class: Window

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

Overrides:

onPopup in class Window

postPopup

protected void postPopup()

Description copied from class: Window

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

Overrides:

postPopup in class Window

getSelectedIndex

public int getSelectedIndex()

isFadeOnPopAndUnpop

public boolean isFadeOnPopAndUnpop()

Returns if this control fades in/out on pop/unpop

setFadeOnPopAndUnpop

public void setFadeOnPopAndUnpop(boolean fadeOnPopAndUnpop)

sets if this control fades in/out on pop/unpop