com.codename1.components

Class SpanButton

java.lang.Object

com.codename1.ui.Component

com.codename1.ui.Container

com.codename1.components.SpanButton

All Implemented Interfaces:

Animation, Editable, ActionSource, StyleListener, IconHolder, SelectableIconHolder, TextHolder, Iterable<Component>

public class SpanButton
extends Container
implements ActionSource, SelectableIconHolder, TextHolder

A complex button similar to MultiButton that breaks lines automatically and looks like a regular button (more or less). Unlike the multi button the span button has the UIID style of a button.

Author:

Shai Almog

Field Summary

Fields inherited from class com.codename1.ui.Component

BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, CROSSHAIR_CURSOR, DEFAULT_CURSOR, DRAG_REGION_IMMEDIATELY_DRAG_X, DRAG_REGION_IMMEDIATELY_DRAG_XY, DRAG_REGION_IMMEDIATELY_DRAG_Y, DRAG_REGION_LIKELY_DRAG_X, DRAG_REGION_LIKELY_DRAG_XY, DRAG_REGION_LIKELY_DRAG_Y, DRAG_REGION_NOT_DRAGGABLE, DRAG_REGION_POSSIBLE_DRAG_X, DRAG_REGION_POSSIBLE_DRAG_XY, DRAG_REGION_POSSIBLE_DRAG_Y, E_RESIZE_CURSOR, HAND_CURSOR, LEFT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NW_RESIZE_CURSOR, RIGHT, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, TOP, W_RESIZE_CURSOR, WAIT_CURSOR

Constructor Summary

Constructors

Constructor and Description
SpanButton() Default constructor will be useful when adding this to the GUI builder
SpanButton(String txt) Constructor accepting default text
SpanButton(String txt, String textUiid) Constructor accepting default text and uiid for the text

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Binds an action listener to button events
void	addLongPressListener(ActionListener l) Binds long press listener to button events.
Command	getCommand() Returns the command instance of the button
Image	getDisabledIcon() Returns the disabled icon of the button
char	getFontIcon() Returns the font icon assigned to this component or 0 if not applicable
float	getFontIconSize() Returns the icon size assigned to this component or 0/-1 if not applicable
int	getGap() Returns the gap in pixels between the icon/text to the Label boundaries
Image	getIcon() Returns the image of the icon
Font	getIconFont() Returns the font for the icon font or null if not font set
Image	getIconFromState() Returns the icon for the button based on its current state
String	getIconPosition() Returns the icon position based on border layout constraints
Component	getIconStyleComponent() Gets the component used for styling font icons on this SpanLabel.
String	getIconUIID() Returns the UIID for the icon
char	getMaterialIcon() Returns the material icon assigned to this component or 0 if not applicable
float	getMaterialIconSize() Returns the material icon size assigned to this component or 0/-1 if not applicable
Image	getPressedIcon() Returns the pressed icon of the button
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
String[]	getPropertyTypeNames() This method is here to workaround an XMLVM array type bug where property types aren't identified properly, it returns the names of the types using the following type names: String,int,double,long,byte,short,char,String[],String[][],byte[],Image,Image[],Object[],ListModel,ListCellRenderer
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() Returns the rollover icon of the button
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 text of the button
Style	getTextAllStyles() Returns the Style proxy object for the text of this span button.
TextArea	getTextComponent() Returns the TextArea holding the actual text
int	getTextPosition() Returns The position of the text relative to the icon
Style	getTextStyle() Returns the Style object for the text of this span button.
String	getTextUIID() Returns the uiid of the actual text
boolean	isAutoRelease() Returns if this is an auto released Button.
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 l) Removes the listener from tracking button events
void	removeLongPressListener(ActionListener l) Unbinds long press listener to button events.
void	setAutoRelease(boolean autoRelease) Sets the auto released mode of this button, by default it's not an auto released Button
void	setCommand(Command cmd) Sets the command for the component
void	setDisabledIcon(Image i) Sets the disabled icon for the button
void	setFontIcon(Font font, char c) This method is shorthand for com.codename1.ui.FontImage#setMaterialIcon(com.codename1.ui.Label, com.codename1.ui.Font, char)
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	setIcon(Image i) Sets the icon for the button
void	setIconPosition(String t) Sets the icon position based on border layout constraints
void	setIconUIID(String uiid) Sets the uiid for the icon if present
void	setMaterialIcon(char c) This method is shorthand for FontImage.setMaterialIcon(com.codename1.ui.Label, char)
void	setMaterialIcon(char c, float size) This method is shorthand for FontImage.setMaterialIcon(com.codename1.ui.Label, char, float)
void	setPressedIcon(Image i) Sets the pressed icon for the button
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	setRolloverIcon(Image i) Sets the rollover icon for the button
void	setRolloverPressedIcon(Image arg0) Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
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 t) Set the text of the button
void	setTextPosition(int textPosition) Sets the position of the text relative to the icon if exists
void	setTextUIID(String uiid) Sets the UIID for the actual text
void	setWidth(int width) Sets the Component width, this method is exposed for the purpose of external layout managers and should not be invoked directly. If a user wishes to affect the component size, setPreferredSize should be used.

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, iterator, iterator, keyPressed, keyReleased, layoutContainer, morph, morphAndWait, paint, 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, addPointerPressedListener, addPointerReleasedListener, 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, 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, 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, paintBackground, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, parsePreferredSize, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, 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, setX, setY, shouldBlockSideSwipe, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SpanButton

public SpanButton()

Default constructor will be useful when adding this to the GUI builder

SpanButton

public SpanButton(String txt,
                  String textUiid)

Constructor accepting default text and uiid for the text

Parameters:

txt - the text

textUiid - the new text UIID

SpanButton

public SpanButton(String txt)

Constructor accepting default text

Method Detail

getTextComponent

public TextArea getTextComponent()

Returns the TextArea holding the actual text

Returns:

the component

setTextUIID

public void setTextUIID(String uiid)

Sets the UIID for the actual text

Parameters:

uiid - the uiid

getTextUIID

public String getTextUIID()

Returns the uiid of the actual text

Returns:

the uiid

getIconStyleComponent

public Component getIconStyleComponent()

Gets the component used for styling font icons on this SpanLabel.

Specified by:

getIconStyleComponent in interface IconHolder

Returns:

The component used for styling font icons on this SpanLabel.

Since:

7.0

getTextAllStyles

public Style getTextAllStyles()

Returns the Style proxy object for the text of this span button.

Returns:

The Style object for the text of this span button.

getTextStyle

public Style getTextStyle()

Returns the Style object for the text of this span button.

Returns:

The Style object for the text of this span button.

setIconUIID

public void setIconUIID(String uiid)

Sets the uiid for the icon if present

Specified by:

setIconUIID in interface IconHolder

Parameters:

uiid - the uiid for the icon

getIconUIID

public String getIconUIID()

Returns the UIID for the icon

Specified by:

getIconUIID in interface IconHolder

Returns:

the uiid

setText

public void setText(String t)

Set the text of the button

Specified by:

setText in interface TextHolder

Parameters:

t - text of the button

setIcon

public void setIcon(Image i)

Sets the icon for the button

Specified by:

setIcon in interface IconHolder

Parameters:

i - the icon

getText

public String getText()

Returns the text of the button

Specified by:

getText in interface TextHolder

Returns:

the text

getIcon

public Image getIcon()

Returns the image of the icon

Specified by:

getIcon in interface IconHolder

Returns:

the icon

addLongPressListener

public void addLongPressListener(ActionListener l)

Binds long press listener to button events.

Overrides:

addLongPressListener in class Component

Parameters:

l -

Since:

7.0

removeLongPressListener

public void removeLongPressListener(ActionListener l)

Unbinds long press listener to button events.

Overrides:

removeLongPressListener in class Component

Parameters:

l -

Since:

7.0

addActionListener

public void addActionListener(ActionListener l)

Binds an action listener to button events

Specified by:

addActionListener in interface ActionSource

Parameters:

l - the listener

removeActionListener

public void removeActionListener(ActionListener l)

Removes the listener from tracking button events

Specified by:

removeActionListener in interface ActionSource

Parameters:

l - the listener

setIconPosition

public void setIconPosition(String t)

Sets the icon position based on border layout constraints

Parameters:

s - 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

setCommand

public void setCommand(Command cmd)

Sets the command for the component

Parameters:

cmd - the command

getCommand

public Command getCommand()

Returns the command instance of the button

Returns:

the command instance of the button

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

getPropertyTypeNames

public String[] getPropertyTypeNames()

This method is here to workaround an XMLVM array type bug where property types aren't identified properly, it returns the names of the types using the following type names: String,int,double,long,byte,short,char,String[],String[][],byte[],Image,Image[],Object[],ListModel,ListCellRenderer

Overrides:

getPropertyTypeNames in class Component

Returns:

Array of type names

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

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

setPressedIcon

public void setPressedIcon(Image i)

Sets the pressed icon for the button

Specified by:

setPressedIcon in interface SelectableIconHolder

Parameters:

i - the icon

See Also:

Button.STATE_PRESSED

getPressedIcon

public Image getPressedIcon()

Returns the pressed icon of the button

Specified by:

getPressedIcon in interface SelectableIconHolder

Returns:

the pressed icon

See Also:

Button.STATE_PRESSED

setRolloverIcon

public void setRolloverIcon(Image i)

Sets the rollover icon for the button

Specified by:

setRolloverIcon in interface SelectableIconHolder

Parameters:

i - the icon

See Also:

Button.STATE_ROLLOVER

getRolloverIcon

public Image getRolloverIcon()

Returns the rollover icon of the button

Specified by:

getRolloverIcon in interface SelectableIconHolder

Returns:

the pressed icon

See Also:

Button.STATE_ROLLOVER

setDisabledIcon

public void setDisabledIcon(Image i)

Sets the disabled icon for the button

Specified by:

setDisabledIcon in interface SelectableIconHolder

Parameters:

i - the icon

getDisabledIcon

public Image getDisabledIcon()

Returns the disabled icon of the button

Specified by:

getDisabledIcon in interface SelectableIconHolder

Returns:

the pressed icon

isAutoRelease

public boolean isAutoRelease()

Returns if this is an auto released Button. Auto released Buttons will are been disarmed when a drag is happening within the Button.

Returns:

true if it's an auto released Button.

setAutoRelease

public void setAutoRelease(boolean autoRelease)

Sets the auto released mode of this button, by default it's not an auto released Button

setWidth

public void setWidth(int width)

Description copied from class: Component

Sets the Component width, this method is exposed for the purpose of external layout managers and should not be invoked directly.
If a user wishes to affect the component size, setPreferredSize should be used.

Overrides:

setWidth in class Component

Parameters:

width - the width of the component

See Also:

Component.setPreferredSize(com.codename1.ui.geom.Dimension)

setGap

public void setGap(int gap)

Description copied from interface: IconHolder

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

getGap

public int getGap()

Description copied from interface: IconHolder

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

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)

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

See Also:

#LEFT, #RIGHT, #BOTTOM, #TOP

setRolloverPressedIcon

public void setRolloverPressedIcon(Image arg0)

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:

arg0 - 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

setMaterialIcon

public void setMaterialIcon(char c)

This method is shorthand for FontImage.setMaterialIcon(com.codename1.ui.Label, char)

Parameters:

c - one of the constants from FontImage

setFontIcon

public void setFontIcon(Font font,
                        char c)

This method is shorthand for com.codename1.ui.FontImage#setMaterialIcon(com.codename1.ui.Label, com.codename1.ui.Font, char)

Parameters:

c - one of the constants from the font

setMaterialIcon

public void setMaterialIcon(char c,
                            float size)

This method is shorthand for FontImage.setMaterialIcon(com.codename1.ui.Label, char, float)

Parameters:

c - one of the constants from FontImage

size - the size of the icon in millimeters

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)

Parameters:

c - one of the constants from the font

size - the size of the icon in millimeters

getMaterialIcon

public char getMaterialIcon()

Returns the material icon assigned to this component or 0 if not applicable

Returns:

the material icon

getFontIcon

public char getFontIcon()

Returns the font icon assigned to this component or 0 if not applicable

Returns:

the material icon

getMaterialIconSize

public float getMaterialIconSize()

Returns the material icon size assigned to this component or 0/-1 if not applicable

Returns:

the material icon size

getFontIconSize

public float getFontIconSize()

Returns the icon size assigned to this component or 0/-1 if not applicable

Returns:

the icon size

getIconFont

public Font getIconFont()

Returns the font for the icon font or null if not font set

Returns:

the material icon size