ButtonMenu (TotalCrossSDK 6.1.0 API)

java.lang.Object
- totalcross.ui.gfx.GfxSurface
- - totalcross.ui.Control
  - - totalcross.ui.Container
    - - totalcross.ui.ScrollContainer
      - totalcross.ui.ButtonMenu

All Implemented Interfaces:

EventHandler, PressListener, UpdateListener, Scrollable
```
public class ButtonMenu
extends ScrollContainer
implements PressListener
```
This class adds a multi-button menu that can be scrolled horizontally (single-row) or vertically (multiple-rows), using a scrollbar or flicking. The buttons can have almost all properties present in the Button class, like:
- textPosition
- borderType
- cornerRadius3DG
- borderWidth3DG
- borderColor3DG
- topColor3DG
- bottomColor3DG
There are also other properties that can be set, like:
- textGap
- buttonVertGap
- buttonHorizGap
- imageSize
- borderGap
The sizes above are not in pixels, but in percentage of the font's height. So, a value of 25 means 25% of the font's height, or 1/4; 150 means 150% of the font's height, or 1.5x; and so on. This enabled the gaps be constant in physical inches no matter the screen DPI or resolution. See the AndroidUI program for a sample of how to use this class.
Since:

TotalCross 1.3

See Also:

pagePositionDisposition

Nested Class Summary
- Nested classes/interfaces inherited from class totalcross.ui.Control
  Control.TranslucentShape

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`borderColor3DG`
`int`	`borderGap` The gap between the text or image and the button borders, in percentage of the font's height.
`byte`	`borderType`
`int`	`borderWidth3DG`
`int`	`bottomColor3DG`
`int`	`buttonHorizGap` The gap between two horizontal buttons, in percentage of the font's height.
`int`	`buttonVertGap` The gap between two vertical buttons, in percentage of the font's height.
`int`	`cornerRadius3DG`
`int`	`imageSize` The size of the image, in percentage of the font's height.
`static int`	`MULTIPLE_HORIZONTAL` Used in the disposition member of the constructor.
`static int`	`MULTIPLE_VERTICAL` Used in the disposition member of the constructor.
`static int`	`NO_PAGEPOSITION` Used in the pagePositionDisposition.
`protected PagePosition`	`pagepos` The control that keeps track of the current position.
`static int`	`PAGEPOSITION_AT_BOTTOM` Used in the pagePositionDisposition.
`static int`	`PAGEPOSITION_AT_TOP` Used in the pagePositionDisposition.
`int`	`pagePositionDisposition` If disposition is a MULTIPLE_HORIZONTAL, set how the PagePosition will replace the ScrollPosition control.
`int`	`pressedColor`
`static int`	`SINGLE_COLUMN` Used in the disposition member of the constructor.
`static int`	`SINGLE_ROW` Used in the disposition member of the constructor.
`int`	`textGap` The gap between the image and the text, in percentage of the font's height.
`int`	`textPosition` Where to place the text (supports only LEFT, TOP, RIGHT, BOTTOM, CENTER - no adjustments!).
`int`	`topColor3DG`

Fields inherited from class totalcross.ui.ScrollContainer
autoScroll, bag, bag0, disabledFlick, flick, hsIgnoreAutoScroll, lastH, lastV, sbH, sbV, shrink2size

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, 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
`ButtonMenu(Image[] images, int disposition)` Constructs an ButtonMenu with the giving images and no names.
`ButtonMenu(Image[] images, java.lang.String[] names, int disposition)` Constructs an ButtonMenu with the giving images ant names.
`ButtonMenu(java.lang.String[] names, int disposition)` Constructs an ButtonMenu with the giving names and no images.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`controlPressed(ControlEvent e)` A PRESSED event was dispatched.
`protected Button`	`createButton(java.lang.String name, Image img, int textPosition, int tg)`
`Button`	`getButton(int idx)` Returns the button at the given index.
`int`	`getPreferredHeight()` Returns the preferred height as if all images were in a single row.
`int`	`getPreferredHeight(int rows)` Returns the preferred height for the given number of rows.
`int`	`getPreferredWidth()` Returns the preferred width as if all images were in a single row.
`int`	`getPreferredWidth(int cols)` Returns the preferred width for the given number of columns.
`int`	`getSelectedIndex()`
`void`	`initUI()` Called to initialize the User Interface of this container.
`void`	`onFontChanged()` Creates and resizes all Button and images.
`void`	`replaceWith(Image[] images, java.lang.String[] names)` Changes all the buttons to the given parameters.
`void`	`reposition()` Reposition this control, calling again setRect with the original parameters.

Methods inherited from class totalcross.ui.Container
add, add, add, add, broadcastEvent, clear, fillBackground, findChild, findNearestChild, findNextFocusControl, getBorderRadius, getBorderStyle, getChildren, getChildrenCount, getClientRect, getFirstChild, getFocusableControls, getInsets, incLastX, incLastY, isPressed, moveFocusToNextEditable, onAddAgain, onRemove, onSwapFinished, paintChildren, resizeHeight, resizeWidth, 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, isTopMost, isVisible, isVisibleAndInside, onWindowPaintFinished, post, postEvent, postPressedEvent, 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
  - pagepos
```
protected PagePosition pagepos
```
    The control that keeps track of the current position.
  - textGap
```
public int textGap
```
    The gap between the image and the text, in percentage of the font's height. Defaults to 25 (%).
  - buttonVertGap
```
public int buttonVertGap
```
    The gap between two vertical buttons, in percentage of the font's height. Also used as gap between the button and the ButtonMenu's border. Defaults to 100 (%).
  - buttonHorizGap
```
public int buttonHorizGap
```
    The gap between two horizontal buttons, in percentage of the font's height. Also used as gap between the button and the ButtonMenu's border. Defaults to 100 (%).
  - imageSize
```
public int imageSize
```
    The size of the image, in percentage of the font's height. Defaults to 200 (%). Set to -1 to keep the original size.
  - borderGap
```
public int borderGap
```
    The gap between the text or image and the button borders, in percentage of the font's height. Defaults to 10 (%).
  - PAGEPOSITION_AT_BOTTOM
```
public static final int PAGEPOSITION_AT_BOTTOM
```
    Used in the pagePositionDisposition. Place it at bottom.
    
    See Also:
    
    Constant Field Values
  - PAGEPOSITION_AT_TOP
```
public static final int PAGEPOSITION_AT_TOP
```
    Used in the pagePositionDisposition. Place it at top.
    
    See Also:
    
    Constant Field Values
  - NO_PAGEPOSITION
```
public static final int NO_PAGEPOSITION
```
    Used in the pagePositionDisposition. Don't use a PagePosition, use the ScrollPosition instead.
    
    See Also:
    
    Constant Field Values
  - pagePositionDisposition
```
public int pagePositionDisposition
```
    If disposition is a MULTIPLE_HORIZONTAL, set how the PagePosition will replace the ScrollPosition control.
    
    See Also:
    
    PAGEPOSITION_AT_BOTTOM, PAGEPOSITION_AT_TOP, NO_PAGEPOSITION
  - textPosition
```
public int textPosition
```
    Where to place the text (supports only LEFT, TOP, RIGHT, BOTTOM, CENTER - no adjustments!). Also supports RIGHT_OF (relativeToText is computed automatically). Defaults to CENTER.
  - borderType
```
public byte borderType
```
    See Also:
    
    Button.setBorder(byte)
  - cornerRadius3DG
```
public int cornerRadius3DG
```
    See Also:
    
    Button.cornerRadius3DG
  - borderWidth3DG
```
public int borderWidth3DG
```
    See Also:
    
    Button.borderWidth3DG
  - borderColor3DG
```
public int borderColor3DG
```
    See Also:
    
    Button.borderColor3DG
  - topColor3DG
```
public int topColor3DG
```
    See Also:
    
    Button.topColor3DG
  - bottomColor3DG
```
public int bottomColor3DG
```
    See Also:
    
    Button.bottomColor3DG
  - pressedColor
```
public int pressedColor
```
    See Also:
    
    Button.setPressedColor(int)
  - SINGLE_COLUMN
```
public static final int SINGLE_COLUMN
```
    Used in the disposition member of the constructor. The menu will have a single column and multiple rows and will scroll vertically.
    
    See Also:
    
    Constant Field Values
  - SINGLE_ROW
```
public static final int SINGLE_ROW
```
    Used in the disposition member of the constructor. The menu will have a single row and multiple columns and will scroll horizontally.
    
    See Also:
    
    Constant Field Values
  - MULTIPLE_HORIZONTAL
```
public static final int MULTIPLE_HORIZONTAL
```
    Used in the disposition member of the constructor. The menu will have multiple columns and rows and will scroll horizontally.
    
    See Also:
    
    Constant Field Values
  - MULTIPLE_VERTICAL
```
public static final int MULTIPLE_VERTICAL
```
    Used in the disposition member of the constructor. The menu will have multiple columns and rows and will scroll vertically.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ButtonMenu
```
public ButtonMenu(Image[] images,
                  int disposition)
```
    Constructs an ButtonMenu with the giving images and no names.
    
    See Also:
    
    SINGLE_COLUMN, SINGLE_ROW, MULTIPLE_HORIZONTAL, MULTIPLE_VERTICAL
  - ButtonMenu
```
public ButtonMenu(java.lang.String[] names,
                  int disposition)
```
    Constructs an ButtonMenu with the giving names and no images.
    
    See Also:
    
    SINGLE_COLUMN, SINGLE_ROW, MULTIPLE_HORIZONTAL, MULTIPLE_VERTICAL
  - ButtonMenu
```
public ButtonMenu(Image[] images,
                  java.lang.String[] names,
                  int disposition)
```
    Constructs an ButtonMenu with the giving images ant names.
    
    See Also:
    
    SINGLE_COLUMN, SINGLE_ROW, MULTIPLE_HORIZONTAL, MULTIPLE_VERTICAL
- Method Detail
  - replaceWith
```
public void replaceWith(Image[] images,
                        java.lang.String[] names)
```
    Changes all the buttons to the given parameters. If you don't want to set the images or the names, pass null in the proper place. Calls onFontChanged and initUI to reset the buttons.
    
    Since:
    
    TotalCross 1.66
  - getButton
```
public Button getButton(int idx)
```
    Returns the button at the given index. You may customize it.
    
    Since:
    
    TotalCross 2.0
  - onFontChanged
```
public void onFontChanged()
```
    Creates and resizes all Button and images. For better performance, call setFont for this control BEFORE calling add or setRect (this is a general rule for all other controls as well).
    
    Overrides:
    
    onFontChanged in class ScrollContainer
  - createButton
```
protected Button createButton(java.lang.String name,
                              Image img,
                              int textPosition,
                              int tg)
```
  - 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 ScrollContainer
  - getPreferredWidth
```
public int getPreferredWidth()
```
    Returns the preferred width as if all images were in a single row.
    
    Overrides:
    
    getPreferredWidth in class ScrollContainer
  - getPreferredWidth
```
public int getPreferredWidth(int cols)
```
    Returns the preferred width for the given number of columns.
  - getPreferredHeight
```
public int getPreferredHeight()
```
    Returns the preferred height as if all images were in a single row.
    
    Overrides:
    
    getPreferredHeight in class ScrollContainer
  - getPreferredHeight
```
public int getPreferredHeight(int rows)
```
    Returns the preferred height for the given number of rows. For example:
```
 add(ib2,LEFT+10,CENTER,FILL-10,ib2.getPreferredHeight(4));
 
```
  - getSelectedIndex
```
public int getSelectedIndex()
```
  - controlPressed
```
public void controlPressed(ControlEvent e)
```
    Description copied from interface: PressListener
    
    A PRESSED event was dispatched.
    
    Specified by:
    
    controlPressed in interface PressListener
    
    See Also:
    
    ControlEvent

Class ButtonMenu

Nested Class Summary

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

Field Summary

Fields inherited from class totalcross.ui.ScrollContainer

Fields inherited from class totalcross.ui.Container

Fields inherited from class totalcross.ui.Control

Constructor Summary

Method Summary

Methods inherited from class totalcross.ui.ScrollContainer

Methods inherited from class totalcross.ui.Container

Methods inherited from class totalcross.ui.Control

Methods inherited from class java.lang.Object

Field Detail

pagepos

textGap

buttonVertGap

buttonHorizGap

imageSize

borderGap

PAGEPOSITION_AT_BOTTOM

PAGEPOSITION_AT_TOP

NO_PAGEPOSITION

pagePositionDisposition

textPosition

borderType

cornerRadius3DG

borderWidth3DG

borderColor3DG

topColor3DG

bottomColor3DG

pressedColor

SINGLE_COLUMN

SINGLE_ROW

MULTIPLE_HORIZONTAL

MULTIPLE_VERTICAL

Constructor Detail

ButtonMenu

ButtonMenu

ButtonMenu

Method Detail

replaceWith

getButton

onFontChanged

createButton

initUI

reposition

getPreferredWidth

getPreferredWidth

getPreferredHeight

getPreferredHeight

getSelectedIndex

controlPressed