MultiButton (Codename One API)

java.lang.Object
- com.codename1.ui.Component
- - com.codename1.ui.Container
  - - com.codename1.components.MultiButton

All Implemented Interfaces:

Animation, Editable, ActionSource, StyleListener, IconHolder, SelectableIconHolder, TextHolder, Iterable<Component>
```
public class MultiButton
extends Container
implements ActionSource, SelectableIconHolder, TextHolder
```
A powerful button like component that allows multiple rows/and an icon to be added every row/icon can have its own UIID. Internally the multi-button is a container with a lead component. Up to 4 rows are supported.

See Also:

SpanButton

Constructor Summary

Constructors
Constructor and Description
`MultiButton()` Default constructor allowing the designer to create an instance of this class
`MultiButton(String line1)` Initializes a multibutton with the first line of text

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActionListener(ActionListener al)` Adds an action listener
`void`	`addLongPressListener(ActionListener l)` Adds a listener to the pointer event
`void`	`addPointerPressedListener(ActionListener l)` Adds a listener to the pointer event
`void`	`addPointerReleasedListener(ActionListener l)` Adds a listener to the pointer event
`Component`	`getBadgeStyleComponent()` Gets a component that can be used for the style of the badge.
`String`	`getBadgeText()` Gets the text to be used in a badge on this label.
`Command`	`getCommand()` Returns the command for the emblem
`Image`	`getDisabledIcon()` Indicates the icon that is displayed on the button when the button is in the disabled state
`Image`	`getEmblem()` Returns the emblem image
`String`	`getEmblemName()` Returns the name of the emblem
`String`	`getEmblemPosition()` Returns the emblem position based on border layout constraints
`String`	`getEmblemUIID()` Returns the UIID of the Emblem
`int`	`getGap()` Returns the gap in pixels between the icon/text to the Label boundaries
`String`	`getGroup()` Indicates the group for the radio button
`Image`	`getIcon()` Returns the icon image
`Label`	`getIconComponent()` Allows us to gain direct access to the icon component so we can set it directly without going via the other methods, this is especially useful for classes such as the ImageDownloadService which can then update the icon seamlessly.
`Image`	`getIconFromState()` Returns the icon for the button based on its current state
`String`	`getIconName()` Returns the name of the icon
`String`	`getIconPosition()` Returns the icon position based on border layout constraints
`Component`	`getIconStyleComponent()` Gets the component that should be used for styling material the material icon.
`String`	`getIconUIID()` Returns the UIID of the Icon
`String`	`getMaskName()` Set the mask name for the icon
`String`	`getNameLine1()` Returns the name of the row
`String`	`getNameLine2()` Returns the name of the row
`String`	`getNameLine3()` Returns the name of the row
`String`	`getNameLine4()` Returns the name of the row
`Image`	`getPressedIcon()` Indicates the icon that is displayed on the button when the button is in pressed state
`String[]`	`getPropertyNames()` A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code
`Class[]`	`getPropertyTypes()` Matches the property names method (see that method for further details).
`Object`	`getPropertyValue(String name)` Returns the current value of the property name, this method is used by the GUI builder
`Image`	`getRolloverIcon()` Indicates the icon that is displayed on the button when the button is in rolled over state
`Image`	`getRolloverPressedIcon()` Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
`String`	`getText()` Returns the line 1 text The text of the component
`String`	`getTextLine1()` Returns the content of the row
`String`	`getTextLine2()` Returns the content of the row
`String`	`getTextLine3()` Returns the content of the row
`String`	`getTextLine4()` Returns the content of the row
`String`	`getTextLines()` Gets all text in multibutton in a single string delimited by "\n" character.
`int`	`getTextPosition()` Returns The position of the text relative to the icon
`String`	`getUIIDLine1()` Returns the UIID of the row
`String`	`getUIIDLine2()` Returns the UIID of the row
`String`	`getUIIDLine3()` Returns the UIID of the row
`String`	`getUIIDLine4()` Returns the UIID of the row
`boolean`	`isCheckBox()` Returns true if this is a checkbox button
`boolean`	`isHorizontalLayout()` Indicates whether the first two labels are be side by side
`boolean`	`isInvertFirstTwoEntries()` Inverts the order of the first two entries so the second line appears first.
`boolean`	`isLinesTogetherMode()` Indicates if the lines are grouped together on this button
`boolean`	`isRadioButton()` Returns true if this is a radio button
`boolean`	`isSelected()` Returns true if the checkbox/radio button is selected
`boolean`	`isShouldLocalize()` Indicates if text should be localized when set to the component, by default all text is localized so this allows disabling automatic localization for a specific component.
`void`	`removeActionListener(ActionListener al)` Removes an action listener
`void`	`removeLongPressListener(ActionListener l)` Removes the listener from the pointer event
`void`	`removePointerPressedListener(ActionListener l)` Removes the listener from the pointer event
`void`	`removePointerReleasedListener(ActionListener l)` Removes the listener from the pointer event
`void`	`setBadgeText(String badgeText)` Sets the badge text to be used on this label.
`void`	`setBadgeUIID(String badgeUIID)` Sets the style that should be used for rendering badges.
`void`	`setCheckBox(boolean b)` Turns the multi-button into a checkbox multi-button
`void`	`setCommand(Command c)` Sets the command for the component, it doesn't affe
`void`	`setDisabledIcon(Image arg0)` Indicates the icon that is displayed on the button when the button is in the disabled state
`void`	`setEmblem(Image i)` Sets the emblem
`void`	`setEmblemName(String t)` Sets the name of the emblem (important for use in generic renderers
`void`	`setEmblemPosition(String t)` Sets the emblem position based on border layout constraints
`void`	`setEmblemUIID(String t)` Sets the UIID of the emblem
`void`	`setFontIcon(Font font, char c, float size)` This method is shorthand for `FontImage.setFontIcon(com.codename1.ui.Label, com.codename1.ui.Font, char, float)`
`void`	`setGap(int gap)` Set the gap in pixels between the icon/text to the Label boundaries
`void`	`setGroup(ButtonGroup bg)` Sets the button group for a radio button mode multibutton
`void`	`setGroup(String group)` Indicates the group for the radio button
`void`	`setHorizontalLayout(boolean b)` Indicates the first two labels should be side by side
`void`	`setIcon(Image i)` Sets the icon
`void`	`setIconName(String t)` Sets the name of the icon (important for use in generic renderers
`void`	`setIconPosition(String t)` Sets the icon position based on border layout constraints
`void`	`setIconUIID(String t)` Sets the UIID of the icon
`void`	`setInvertFirstTwoEntries(boolean b)` Inverts the order of the first two entries so the second line appears first.
`void`	`setLinesTogetherMode(boolean l)` Changes the layout so the lines of the button are grouped together
`void`	`setMaskName(String maskName)` The mask name for the icon
`void`	`setMaterialIcon(char c, float size)` This method is shorthand for `FontImage.setMaterialIcon(com.codename1.ui.Label, char, float)`
`void`	`setNameLine1(String t)` Sets the name of the row (important for use in generic renderers)
`void`	`setNameLine2(String t)` Sets the name of the row (important for use in generic renderers
`void`	`setNameLine3(String t)` Sets the name of the row (important for use in generic renderers
`void`	`setNameLine4(String t)` Sets the name of the row (important for use in generic renderers
`void`	`setPressedIcon(Image arg0)` Indicates the icon that is displayed on the button when the button is in pressed state
`String`	`setPropertyValue(String name, Object value)` Sets a new value to the given property, returns an error message if failed and null if successful.
`void`	`setRadioButton(boolean b)` Turns the multi-button into a radio multi-button
`void`	`setRolloverIcon(Image arg0)` Indicates the icon that is displayed on the button when the button is in rolled over state
`void`	`setRolloverPressedIcon(Image icn)` Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
`void`	`setSelected(boolean b)` Toggles the selected state for the radio button/check box modes
`void`	`setShouldLocalize(boolean shouldLocalize)` Indicates if text should be localized when set to the component, by default all text is localized so this allows disabling automatic localization for a specific component.
`void`	`setText(String text)` Sets the line 1 text New text for the component
`void`	`setTextLine1(String t)` Sets the content of the row
`void`	`setTextLine2(String t)` Sets the content of the row
`void`	`setTextLine3(String t)` Sets the content of the row
`void`	`setTextLine4(String t)` Sets the content of the row
`void`	`setTextLines(String text)` Sets textLine1, textLine2, textLine3, and textLine4 in single method with single string using "\n" as a delimiter.
`void`	`setTextPosition(int textPosition)` Sets the position of the text relative to the icon if exists
`void`	`setUIIDLine1(String t)` Sets the UIID of the row
`void`	`setUIIDLine2(String t)` Sets the UIID of the row
`void`	`setUIIDLine3(String t)` Sets the UIID of the row
`void`	`setUIIDLine4(String t)` Sets the UIID of the row

Methods inherited from class com.codename1.ui.Container
add, add, add, add, add, add, addAll, addComponent, addComponent, addComponent, addComponent, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, constrainHeightWhenScrollable, constrainWidthWhenScrollable, contains, createAnimateHierarchy, createAnimateHierarchyFade, createAnimateLayout, createAnimateLayoutFade, createAnimateLayoutFadeAndWait, createAnimateMotion, createAnimateUnlayout, createReplaceTransition, dragInitiated, drop, encloseIn, encloseIn, findDropTargetAt, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getChildrenAsList, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getComponentIndex, getGridPosX, getGridPosY, getLayout, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getResponderAt, getSafeAreaRoot, getScrollIncrement, getSideGap, getUIManager, initLaf, invalidate, isEnabled, isSafeArea, isSafeAreaRoot, isScrollableX, isScrollableY, isSelectableInteraction, isSurface, iterator, iterator, keyPressed, keyReleased, layoutContainer, morph, morphAndWait, paint, paintBackground, paintBorderBackground, paintComponentBackground, paintGlass, paramString, pointerPressed, refreshTheme, removeAll, removeComponent, replace, replace, replaceAndWait, replaceAndWait, replaceAndWait, revalidate, revalidateLater, revalidateWithAnimationSafety, scrollComponentToVisible, setCellRenderer, setEnabled, setLayout, setLeadComponent, setSafeArea, setSafeAreaRoot, setScrollable, setScrollableX, setScrollableY, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout, setUIManager, updateTabIndices

Methods inherited from class com.codename1.ui.Component
addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addPointerDraggedListener, addPullToRefresh, addScrollListener, addStateChangeListener, animate, bindProperty, blocksSideSwipe, calcScrollSize, contains, containsOrOwns, createStyleAnimation, deinitialize, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getAnimationManager, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getEditingDelegate, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getPropertyTypeNames, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initComponent, initCustomStyle, initDisabledStyle, initPressedStyle, initSelectedStyle, initUnselectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isRippleEffect, isRTL, isScrollable, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyRepeated, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removePointerDraggedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDirtyRegion, setDisabledStyle, setDraggable, setDropTarget, setEditingDelegate, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MultiButton
```
public MultiButton(String line1)
```
    Initializes a multibutton with the first line of text
    
    Parameters:
    
    line1 - first line of text
  - MultiButton
```
public MultiButton()
```
    Default constructor allowing the designer to create an instance of this class
- Method Detail
  - setLinesTogetherMode
```
public void setLinesTogetherMode(boolean l)
```
    Changes the layout so the lines of the button are grouped together
    
    Parameters:
    
    l - true to group the lines together
  - isLinesTogetherMode
```
public boolean isLinesTogetherMode()
```
    Indicates if the lines are grouped together on this button
    
    Returns:
  - getIconComponent
```
public Label getIconComponent()
```
    Allows us to gain direct access to the icon component so we can set it directly without going via the other methods, this is especially useful for classes such as the ImageDownloadService which can then update the icon seamlessly.
    
    Returns:
    
    the component used internally to represent the icon
  - setCheckBox
```
public void setCheckBox(boolean b)
```
    Turns the multi-button into a checkbox multi-button
    
    Parameters:
    
    b - true for a checkbox multi-button
  - addActionListener
```
public void addActionListener(ActionListener al)
```
    Adds an action listener
    
    Specified by:
    
    addActionListener in interface ActionSource
    
    Parameters:
    
    al - the action listener
  - removeActionListener
```
public void removeActionListener(ActionListener al)
```
    Removes an action listener
    
    Specified by:
    
    removeActionListener in interface ActionSource
    
    Parameters:
    
    al - the action listener
  - addLongPressListener
```
public void addLongPressListener(ActionListener l)
```
    Adds a listener to the pointer event
    
    Overrides:
    
    addLongPressListener in class Component
    
    Parameters:
    
    l -
  - removeLongPressListener
```
public void removeLongPressListener(ActionListener l)
```
    Removes the listener from the pointer event
    
    Overrides:
    
    removeLongPressListener in class Component
    
    Parameters:
    
    l -
  - addPointerPressedListener
```
public void addPointerPressedListener(ActionListener l)
```
    Adds a listener to the pointer event
    
    Overrides:
    
    addPointerPressedListener in class Component
    
    Parameters:
    
    l -
  - removePointerPressedListener
```
public void removePointerPressedListener(ActionListener l)
```
    Removes the listener from the pointer event
    
    Overrides:
    
    removePointerPressedListener in class Component
    
    Parameters:
    
    l -
  - addPointerReleasedListener
```
public void addPointerReleasedListener(ActionListener l)
```
    Adds a listener to the pointer event
    
    Overrides:
    
    addPointerReleasedListener in class Component
    
    Parameters:
    
    l -
  - removePointerReleasedListener
```
public void removePointerReleasedListener(ActionListener l)
```
    Removes the listener from the pointer event
    
    Overrides:
    
    removePointerReleasedListener in class Component
    
    Parameters:
    
    l -
  - setCommand
```
public void setCommand(Command c)
```
    Sets the command for the component, it doesn't affe
    
    Parameters:
    
    c - the command
  - getCommand
```
public Command getCommand()
```
    Returns the command for the emblem
    
    Returns:
    
    the command instance
  - isCheckBox
```
public boolean isCheckBox()
```
    Returns true if this is a checkbox button
    
    Returns:
    
    true for a checkbox button
  - setRadioButton
```
public void setRadioButton(boolean b)
```
    Turns the multi-button into a radio multi-button
    
    Parameters:
    
    b - true for a radio multi-button
  - isRadioButton
```
public boolean isRadioButton()
```
    Returns true if this is a radio button
    
    Returns:
    
    true for a radio button
  - isSelected
```
public boolean isSelected()
```
    Returns true if the checkbox/radio button is selected
    
    Returns:
    
    true if the checkbox/radio button is selected
  - setSelected
```
public void setSelected(boolean b)
```
    Toggles the selected state for the radio button/check box modes
    
    Parameters:
    
    b - true for checked false for unchecked
  - setHorizontalLayout
```
public void setHorizontalLayout(boolean b)
```
    Indicates the first two labels should be side by side
    
    Parameters:
    
    b - true to place the first two labels side by side
  - isHorizontalLayout
```
public boolean isHorizontalLayout()
```
    Indicates whether the first two labels are be side by side
    
    Returns:
    
    true if the first two labels are side by side
  - setInvertFirstTwoEntries
```
public void setInvertFirstTwoEntries(boolean b)
```
    Inverts the order of the first two entries so the second line appears first. This only works in horizontal mode!
    
    Parameters:
    
    b - true to place the second row entry as the first entry
  - isInvertFirstTwoEntries
```
public boolean isInvertFirstTwoEntries()
```
    Inverts the order of the first two entries so the second line appears first. This only works in horizontal mode!
    
    Returns:
    
    true when the second row entry should be placed before the first entry
  - setTextLine1
```
public void setTextLine1(String t)
```
    Sets the content of the row
    
    Parameters:
    
    t - text to set
  - getTextLine1
```
public String getTextLine1()
```
    Returns the content of the row
    
    Returns:
    
    the text
  - setNameLine1
```
public void setNameLine1(String t)
```
    Sets the name of the row (important for use in generic renderers)
    
    Parameters:
    
    t - name to set
  - getNameLine1
```
public String getNameLine1()
```
    Returns the name of the row
    
    Returns:
    
    the name
  - setUIIDLine1
```
public void setUIIDLine1(String t)
```
    Sets the UIID of the row
    
    Parameters:
    
    t - UIID to set
  - getUIIDLine1
```
public String getUIIDLine1()
```
    Returns the UIID of the row
    
    Returns:
    
    the UIID
  - setTextLine2
```
public void setTextLine2(String t)
```
    Sets the content of the row
    
    Parameters:
    
    t - text to set
  - getTextLine2
```
public String getTextLine2()
```
    Returns the content of the row
    
    Returns:
    
    the text
  - setNameLine2
```
public void setNameLine2(String t)
```
    Sets the name of the row (important for use in generic renderers
    
    Parameters:
    
    t - name to set
  - getNameLine2
```
public String getNameLine2()
```
    Returns the name of the row
    
    Returns:
    
    the name
  - setUIIDLine2
```
public void setUIIDLine2(String t)
```
    Sets the UIID of the row
    
    Parameters:
    
    t - UIID to set
  - getUIIDLine2
```
public String getUIIDLine2()
```
    Returns the UIID of the row
    
    Returns:
    
    the UIID
  - setTextLine3
```
public void setTextLine3(String t)
```
    Sets the content of the row
    
    Parameters:
    
    t - text to set
  - getTextLine3
```
public String getTextLine3()
```
    Returns the content of the row
    
    Returns:
    
    the text
  - setNameLine3
```
public void setNameLine3(String t)
```
    Sets the name of the row (important for use in generic renderers
    
    Parameters:
    
    t - name to set
  - getNameLine3
```
public String getNameLine3()
```
    Returns the name of the row
    
    Returns:
    
    the name
  - setUIIDLine3
```
public void setUIIDLine3(String t)
```
    Sets the UIID of the row
    
    Parameters:
    
    t - UIID to set
  - getUIIDLine3
```
public String getUIIDLine3()
```
    Returns the UIID of the row
    
    Returns:
    
    the UIID
  - setTextLine4
```
public void setTextLine4(String t)
```
    Sets the content of the row
    
    Parameters:
    
    t - text to set
  - getTextLine4
```
public String getTextLine4()
```
    Returns the content of the row
    
    Returns:
    
    the text
  - setNameLine4
```
public void setNameLine4(String t)
```
    Sets the name of the row (important for use in generic renderers
    
    Parameters:
    
    t - name to set
  - getNameLine4
```
public String getNameLine4()
```
    Returns the name of the row
    
    Returns:
    
    the name
  - setUIIDLine4
```
public void setUIIDLine4(String t)
```
    Sets the UIID of the row
    
    Parameters:
    
    t - UIID to set
  - getUIIDLine4
```
public String getUIIDLine4()
```
    Returns the UIID of the row
    
    Returns:
    
    the UIID
  - setIcon
```
public void setIcon(Image i)
```
    Sets the icon
    
    Specified by:
    
    setIcon in interface IconHolder
    
    Parameters:
    
    i - the icon
  - getIcon
```
public Image getIcon()
```
    Returns the icon image
    
    Specified by:
    
    getIcon in interface IconHolder
    
    Returns:
    
    the image instance
  - setEmblem
```
public void setEmblem(Image i)
```
    Sets the emblem
    
    Parameters:
    
    i - the icon
  - getEmblem
```
public Image getEmblem()
```
    Returns the emblem image
    
    Returns:
    
    the image instance
  - setIconPosition
```
public void setIconPosition(String t)
```
    Sets the icon position based on border layout constraints
    
    Parameters:
    
    t - position either North/South/East/West
  - getIconPosition
```
public String getIconPosition()
```
    Returns the icon position based on border layout constraints
    
    Returns:
    
    position either North/South/East/West
  - setEmblemPosition
```
public void setEmblemPosition(String t)
```
    Sets the emblem position based on border layout constraints
    
    Parameters:
    
    t - position either North/South/East/West
  - getEmblemPosition
```
public String getEmblemPosition()
```
    Returns the emblem position based on border layout constraints
    
    Returns:
    
    position either North/South/East/West
  - setIconName
```
public void setIconName(String t)
```
    Sets the name of the icon (important for use in generic renderers
    
    Parameters:
    
    t - name to set
  - getIconName
```
public String getIconName()
```
    Returns the name of the icon
    
    Returns:
    
    the name
  - setIconUIID
```
public void setIconUIID(String t)
```
    Sets the UIID of the icon
    
    Specified by:
    
    setIconUIID in interface IconHolder
    
    Parameters:
    
    t - UIID to set
  - getIconUIID
```
public String getIconUIID()
```
    Returns the UIID of the Icon
    
    Specified by:
    
    getIconUIID in interface IconHolder
    
    Returns:
    
    the UIID
  - setEmblemName
```
public void setEmblemName(String t)
```
    Sets the name of the emblem (important for use in generic renderers
    
    Parameters:
    
    t - name to set
  - getEmblemName
```
public String getEmblemName()
```
    Returns the name of the emblem
    
    Returns:
    
    the name
  - setEmblemUIID
```
public void setEmblemUIID(String t)
```
    Sets the UIID of the emblem
    
    Parameters:
    
    t - UIID to set
  - getEmblemUIID
```
public String getEmblemUIID()
```
    Returns the UIID of the Emblem
    
    Returns:
    
    the UIID
  - setText
```
public void setText(String text)
```
    Sets the line 1 text New text for the component
    
    Specified by:
    
    setText in interface TextHolder
    
    Parameters:
    
    text - the text
  - setTextLines
```
public void setTextLines(String text)
```
    Sets textLine1, textLine2, textLine3, and textLine4 in single method with single string using "\n" as a delimiter.
    
    Parameters:
    
    text - The text to set.
    
    Since:
    
    8.0
  - getTextLines
```
public String getTextLines()
```
    Gets all text in multibutton in a single string delimited by "\n" character.
    
    Returns:
    
    String with textLine1 to textLine4 delimited by "\n"
    
    Since:
    
    8.0
  - getText
```
public String getText()
```
    Returns the line 1 text The text of the component
    
    Specified by:
    
    getText in interface TextHolder
    
    Returns:
    
    the text
  - getPropertyNames
```
public String[] getPropertyNames()
```
    A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code
    
    Overrides:
    
    getPropertyNames in class Component
    
    Returns:
    
    the property names allowing mutation
  - getPropertyTypes
```
public Class[] getPropertyTypes()
```
    Matches the property names method (see that method for further details).
    
    Overrides:
    
    getPropertyTypes in class Component
    
    Returns:
    
    the types of the properties
  - getPropertyValue
```
public Object getPropertyValue(String name)
```
    Returns the current value of the property name, this method is used by the GUI builder
    
    Overrides:
    
    getPropertyValue in class Component
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the value of said property
  - setPropertyValue
```
public String setPropertyValue(String name,
                               Object value)
```
    Sets a new value to the given property, returns an error message if failed and null if successful. Notice that some builtin properties such as "$designMode" might be sent to components to indicate application state.
    
    Overrides:
    
    setPropertyValue in class Component
    
    Parameters:
    
    name - the name of the property
    
    value - new value for the property
    
    Returns:
    
    error message or null
  - getGroup
```
public String getGroup()
```
    Indicates the group for the radio button
    
    Returns:
    
    the group
  - setGroup
```
public void setGroup(String group)
```
    Indicates the group for the radio button
    
    Parameters:
    
    group - the group to set
  - getMaskName
```
public String getMaskName()
```
    Set the mask name for the icon
    
    Returns:
    
    the maskName
  - setMaskName
```
public void setMaskName(String maskName)
```
    The mask name for the icon
    
    Parameters:
    
    maskName - the maskName to set
  - isShouldLocalize
```
public boolean isShouldLocalize()
```
    Indicates if text should be localized when set to the component, by default all text is localized so this allows disabling automatic localization for a specific component.
    
    Returns:
    
    the shouldLocalize value
  - setShouldLocalize
```
public void setShouldLocalize(boolean shouldLocalize)
```
    Indicates if text should be localized when set to the component, by default all text is localized so this allows disabling automatic localization for a specific component.
    
    Parameters:
    
    shouldLocalize - the shouldLocalize to set
  - setGroup
```
public void setGroup(ButtonGroup bg)
```
    Sets the button group for a radio button mode multibutton
    
    Parameters:
    
    bg - the button group
  - setGap
```
public void setGap(int gap)
```
    Set the gap in pixels between the icon/text to the Label boundaries
    
    Specified by:
    
    setGap in interface IconHolder
    
    Parameters:
    
    gap - the gap in pixels
    
    Since:
    
    7.0
  - getGap
```
public int getGap()
```
    Returns the gap in pixels between the icon/text to the Label boundaries
    
    Specified by:
    
    getGap in interface IconHolder
    
    Returns:
    
    the gap in pixels between the icon/text to the Label boundaries
    
    Since:
    
    7.0
  - setTextPosition
```
public void setTextPosition(int textPosition)
```
    Sets the position of the text relative to the icon if exists
    
    Specified by:
    
    setTextPosition in interface IconHolder
    
    Parameters:
    
    textPosition - alignment value (LEFT, RIGHT, BOTTOM or TOP)
    
    Since:
    
    7.0
    
    See Also:
    
    #LEFT, #RIGHT, #BOTTOM, #TOP
  - getTextPosition
```
public int getTextPosition()
```
    Returns The position of the text relative to the icon
    
    Specified by:
    
    getTextPosition in interface IconHolder
    
    Returns:
    
    The position of the text relative to the icon, one of: LEFT, RIGHT, BOTTOM, TOP
    
    Since:
    
    7.0
    
    See Also:
    
    #LEFT, #RIGHT, #BOTTOM, #TOP
  - getIconStyleComponent
```
public Component getIconStyleComponent()
```
    Gets the component that should be used for styling material the material icon. If IconHolder.setIconUIID(java.lang.String) has been used to set a custom UIID for the icon, then this will return a component with that UIID. Otherwise this will just return this component itself.
    
    Specified by:
    
    getIconStyleComponent in interface IconHolder
    
    Returns:
    
    The component to use for styling the material icon.
    
    Since:
    
    7.0
  - setMaterialIcon
```
public void setMaterialIcon(char c,
                            float size)
```
    This method is shorthand for FontImage.setMaterialIcon(com.codename1.ui.Label, char, float)
    
    Specified by:
    
    setMaterialIcon in interface IconHolder
    
    Parameters:
    
    c - one of the constants from FontImage
    
    size - the size of the icon in millimeters
    
    Since:
    
    8.0
  - setFontIcon
```
public void setFontIcon(Font font,
                        char c,
                        float size)
```
    This method is shorthand for FontImage.setFontIcon(com.codename1.ui.Label, com.codename1.ui.Font, char, float)
    
    Specified by:
    
    setFontIcon in interface IconHolder
    
    c - one of the constants from the font
    
    size - the size of the icon in millimeters
    
    Since:
    
    8.0
  - setRolloverIcon
```
public void setRolloverIcon(Image arg0)
```
    Indicates the icon that is displayed on the button when the button is in rolled over state
    
    Specified by:
    
    setRolloverIcon in interface SelectableIconHolder
    
    Parameters:
    
    arg0 - icon to use
    
    Since:
    
    7.0
    
    See Also:
    
    Button.STATE_ROLLOVER
  - getRolloverIcon
```
public Image getRolloverIcon()
```
    Indicates the icon that is displayed on the button when the button is in rolled over state
    
    Specified by:
    
    getRolloverIcon in interface SelectableIconHolder
    
    Returns:
    
    icon used
    
    Since:
    
    7.0
    
    See Also:
    
    Button.STATE_ROLLOVER
  - setPressedIcon
```
public void setPressedIcon(Image arg0)
```
    Indicates the icon that is displayed on the button when the button is in pressed state
    
    Specified by:
    
    setPressedIcon in interface SelectableIconHolder
    
    Parameters:
    
    arg0 - icon used
    
    Since:
    
    7.0
    
    See Also:
    
    Button.STATE_PRESSED
  - getPressedIcon
```
public Image getPressedIcon()
```
    Indicates the icon that is displayed on the button when the button is in pressed state
    
    Specified by:
    
    getPressedIcon in interface SelectableIconHolder
    
    Returns:
    
    icon used
    
    Since:
    
    7.0
    
    See Also:
    
    Button.STATE_PRESSED
  - setDisabledIcon
```
public void setDisabledIcon(Image arg0)
```
    Indicates the icon that is displayed on the button when the button is in the disabled state
    
    Specified by:
    
    setDisabledIcon in interface SelectableIconHolder
    
    Parameters:
    
    arg0 - icon used
    
    Since:
    
    7.0
  - getDisabledIcon
```
public Image getDisabledIcon()
```
    Indicates the icon that is displayed on the button when the button is in the disabled state
    
    Specified by:
    
    getDisabledIcon in interface SelectableIconHolder
    
    Returns:
    
    icon used
    
    Since:
    
    7.0
  - setRolloverPressedIcon
```
public void setRolloverPressedIcon(Image icn)
```
    Indicates the icon that is displayed on the button when the button is in pressed state and is selected. This is ONLY applicable to toggle buttons
    
    Specified by:
    
    setRolloverPressedIcon in interface SelectableIconHolder
    
    Parameters:
    
    icn - icon used
    
    Since:
    
    7.0
  - getRolloverPressedIcon
```
public Image getRolloverPressedIcon()
```
    Indicates the icon that is displayed on the button when the button is in pressed state and is selected. This is ONLY applicable to toggle buttons
    
    Specified by:
    
    getRolloverPressedIcon in interface SelectableIconHolder
    
    Returns:
    
    icon used
    
    Since:
    
    7.0
  - getIconFromState
```
public Image getIconFromState()
```
    Returns the icon for the button based on its current state
    
    Specified by:
    
    getIconFromState in interface SelectableIconHolder
    
    Returns:
    
    the button icon based on its current state
    
    Since:
    
    7.0
  - setBadgeText
```
public void setBadgeText(String badgeText)
```
    Sets the badge text to be used on this label. Badges are rendered in the upper right corner of the label inside round border. The style of the badge can be configured using setBadgeUIID(java.lang.String), but the default style uses the "Badge" UIID, which, by default, uses white text on a red round border background.
    
    Parameters:
    
    badgeText - The text to include in the badge. null or empty strings will result in the badge not being rendered.
    
    Since:
    
    8.0
    
    See Also:
    
    getBadgeText(), getBadgeStyleComponent(), setBadgeUIID(java.lang.String)
  - getBadgeText
```
public String getBadgeText()
```
    Gets the text to be used in a badge on this label.
    
    Returns:
    
    the badge text to be used on this label. May return if no text is set.
    
    Since:
    
    8.0
    
    See Also:
    
    setBadgeText(java.lang.String), setBadgeUIID(java.lang.String), getBadgeStyleComponent()
  - setBadgeUIID
```
public void setBadgeUIID(String badgeUIID)
```
    Sets the style that should be used for rendering badges. By default it will use the "Badge" UIID, which rendered 1.5mm white text on a red round border.
    
    Parameters:
    
    badgeUIID - The UIID to use for the badge.
    
    Since:
    
    8.0
    
    See Also:
    
    setBadgeText(java.lang.String), getBadgeStyleComponent()
  - getBadgeStyleComponent
```
public Component getBadgeStyleComponent()
```
    Gets a component that can be used for the style of the badge.
    
    Returns:
    
    The component whose style can be used to style the badge. May return null if none set.
    
    Since:
    
    8.0
    
    See Also:
    
    setBadgeText(java.lang.String), setBadgeUIID(java.lang.String), getBadgeText()

Class MultiButton

Field Summary

Fields inherited from class com.codename1.ui.Component

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.Container

Methods inherited from class com.codename1.ui.Component

Methods inherited from class java.lang.Object

Constructor Detail

MultiButton

MultiButton

Method Detail

setLinesTogetherMode

isLinesTogetherMode

getIconComponent

setCheckBox

addActionListener

removeActionListener

addLongPressListener

removeLongPressListener

addPointerPressedListener

removePointerPressedListener

addPointerReleasedListener

removePointerReleasedListener

setCommand

getCommand

isCheckBox

setRadioButton

isRadioButton

isSelected

setSelected

setHorizontalLayout

isHorizontalLayout

setInvertFirstTwoEntries

isInvertFirstTwoEntries

setTextLine1

getTextLine1

setNameLine1

getNameLine1

setUIIDLine1

getUIIDLine1

setTextLine2

getTextLine2

setNameLine2

getNameLine2

setUIIDLine2

getUIIDLine2

setTextLine3

getTextLine3

setNameLine3

getNameLine3

setUIIDLine3

getUIIDLine3

setTextLine4

getTextLine4

setNameLine4

getNameLine4

setUIIDLine4

getUIIDLine4

setIcon

getIcon

setEmblem

getEmblem

setIconPosition

getIconPosition

setEmblemPosition

getEmblemPosition

setIconName

getIconName

setIconUIID

getIconUIID

setEmblemName

getEmblemName

setEmblemUIID

getEmblemUIID

setText

setTextLines

getTextLines

getText

getPropertyNames