totalcross.ui

Class SideMenuContainer

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Container

totalcross.ui.SideMenuContainer

All Implemented Interfaces:

EventHandler, PenListener

public class SideMenuContainer
extends Container
implements PenListener

Template for navigation based on a menu using a navbar and a sidenav.

This is an incubating feature, therefore backwards compatibility is not guaranteed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SideMenuContainer.Item
static class	SideMenuContainer.Sub

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
TopMenu	topMenu

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, lastX, lastY, 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
SideMenuContainer(int direction, java.lang.String title, Control... items)
SideMenuContainer(java.lang.String title, Control... items)

Method Summary

Modifier and Type	Method and Description
void	initUI() Called to initialize the User Interface of this container.
void	penDown(PenEvent e) A PEN_DOWN event was dispatched.
void	penDrag(DragEvent e) A PEN_DRAG event was dispatched.
void	penDragEnd(DragEvent e) A PEN_DRAG_END event was dispatched.
void	penDragStart(DragEvent e) A PEN_DRAG_START event was dispatched.
void	penUp(PenEvent e) A PEN_UP event was dispatched.
void	setBackColor(int color) Set the background color of this control.
void	setBarFont(Font f)
void	setForeColor(int color) Set the foreground color of this control.
void	setItemForeColor(int color)
void	swap(SideMenuContainer.Item item) Presents the given SideMenuContainer.Item, swapping the caption and the contents of this SideMenu.

Methods inherited from class totalcross.ui.Container

add, add, add, add, add, broadcastEvent, clear, fillBackground, findChild, findNearestChild, findNextFocusControl, getBorderRadius, getBorderStyle, getChildren, getChildrenCount, getClientRect, getClientRect, getFirstChild, getFocusableControls, getInsets, incLastX, incLastY, isPressed, moveFocusToNextControl, moveFocusToNextEditable, onAddAgain, onColorsChanged, onPaint, onRemove, onSwapFinished, paintChildren, remove, removeAll, resize, resizeHeight, resizeWidth, setBorderRadius, setBorderStyle, 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, getPreferredHeight, getPreferredWidth, getPressedEvent, getPrev, getRect, getSize, getTextShadowColor, getWidth, getX, getX2, getY, getY2, hadParentScrolled, handleGeographicalFocusChangeKeys, hasFocus, internalSetEnabled, intXYWH, isActionEvent, isChildOf, isDisplayed, isEnabled, isFloating, isInsideOrNear, isObscured, isTopMost, isVisible, isVisibleAndInside, onBoundsChanged, onEvent, onFontChanged, onWindowPaintFinished, post, postEvent, postPressedEvent, 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, setBackForeColors, 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

topMenu

public TopMenu topMenu

Constructor Detail

SideMenuContainer

public SideMenuContainer(java.lang.String title,
                         Control... items)

SideMenuContainer

public SideMenuContainer(int direction,
                         java.lang.String title,
                         Control... items)

Method Detail

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

setBarFont

public void setBarFont(Font f)

swap

public void swap(SideMenuContainer.Item item)

Presents the given SideMenuContainer.Item, swapping the caption and the contents of this SideMenu.

Parameters:

item - The item to be presented

setForeColor

public void setForeColor(int color)

Description copied from class: Control

Set the foreground color of this control.

Overrides:

setForeColor in class Control

setItemForeColor

public void setItemForeColor(int color)

setBackColor

public void setBackColor(int color)

Description copied from class: Control

Set the background color of this control.

Overrides:

setBackColor in class Control

penDrag

public void penDrag(DragEvent e)

Description copied from interface: PenListener

A PEN_DRAG event was dispatched.

Specified by:

penDrag in interface PenListener

See Also:

PenEvent

penDown

public void penDown(PenEvent e)

Description copied from interface: PenListener

A PEN_DOWN event was dispatched.

Specified by:

penDown in interface PenListener

See Also:

PenEvent

penUp

public void penUp(PenEvent e)

Description copied from interface: PenListener

A PEN_UP event was dispatched.

Specified by:

penUp in interface PenListener

See Also:

PenEvent

penDragStart

public void penDragStart(DragEvent e)

Description copied from interface: PenListener

A PEN_DRAG_START event was dispatched.

Specified by:

penDragStart in interface PenListener

See Also:

PenEvent

penDragEnd

public void penDragEnd(DragEvent e)

Description copied from interface: PenListener

A PEN_DRAG_END event was dispatched.

Specified by:

penDragEnd in interface PenListener

See Also:

PenEvent