public class SpanLabel extends Container implements IconHolder, TextHolder
A multi line label component that can be easily localized, this is simply based on a text area combined with a label.
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 and Description |
---|
SpanLabel()
Default constructor will be useful when adding this to the GUI builder
|
SpanLabel(String txt)
Constructor accepting default text
|
SpanLabel(String txt,
String textUiid)
Constructor accepting default text and uiid for the text
|
Modifier and Type | Method and Description |
---|---|
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
|
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
|
int |
getIconValign()
Gets the vertical alignment of the icon with respect to the text of the span label.
|
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
|
int |
getPreferredW()
Helper method to retrieve the preferred width of the component.
|
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
|
String |
getText()
Returns the text of the label
|
Style |
getTextAllStyles()
Returns the Style proxy object for the text of this span button.
|
int |
getTextBlockAlign()
Returns the alignment of the whole text block and not the text within it!
|
TextArea |
getTextComponent()
Returns the TextArea holding the actual text
|
int |
getTextPosition()
Returns The position of the text relative to the icon
|
Style |
getTextSelectedStyle()
Returns the text elements style object
|
String |
getTextUIID()
Returns the uiid of the actual text
|
Style |
getTextUnselectedStyle()
Returns the text elements style object
|
protected void |
initLaf(UIManager uim)
This method initializes the Component defaults constants
|
protected void |
initUnselectedStyle(Style unselectedStyle)
Can be overridden by subclasses to perform initialization when the unselected style is set to a new value.
|
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.
|
boolean |
isTextSelectionEnabled()
Checks if text selection is enabled on this SpanLabel.
|
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 label
|
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 |
setIconValign(int align)
Sets the vertical alignment of the icon with respect to the text of the span label.
|
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 |
setPreferredW(int preferredW)
Helper method to set the preferred width of the component.
|
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 |
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 label
|
void |
setTextBlockAlign(int align)
Indicates the alignment of the whole text block, this is different from setting the alignment of the text within
the block since the UIID might have a border or other design element that won't be affected by such alignment.
|
void |
setTextPosition(int textPosition)
Sets the position of the text relative to the icon if exists
|
void |
setTextSelectedStyle(Style t)
The text elements style object
|
void |
setTextSelectionEnabled(boolean enabled)
Enables or disables text selection on this span label.
|
void |
setTextUIID(String uiid)
Sets the UIID for the actual text
|
void |
setTextUnselectedStyle(Style t)
The text elements style object
|
void |
setUIID(String id)
This method sets the Component the Unique identifier.
|
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. |
void |
styleChanged(String propertyName,
Style source)
Invoked to indicate a change in a propertyName of a Style
|
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, 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
addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, 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, getDefaultDragTransparency, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getDragTransparency, 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, 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, initDisabledStyle, initPressedStyle, initSelectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isPinchBlocksDragAndDrop, 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, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, 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, setPinchBlocksDragAndDrop, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPressedStyle, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUnselectedStyle, setVisible, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains
public SpanLabel()
public SpanLabel(String txt, String textUiid)
txt
- the texttextUiid
- the new text UIIDpublic SpanLabel(String txt)
public void styleChanged(String propertyName, Style source)
Component
NOTE By default this will trigger a call to Container.revalidate()
on the parent
container, which is expensive. You can disable this behavior by calling CN.setProperty("Component.revalidateOnStyleChange", "false")
.
The intention is to change this behavior so that the default is to "not" revalidate on style change, so we encourage you to
set this to "false" to ensure for future compatibility.
styleChanged
in interface StyleListener
styleChanged
in class Component
propertyName
- the property name that was changedsource
- The changed Style objectprotected void initUnselectedStyle(Style unselectedStyle)
Component
initUnselectedStyle
in class Component
unselectedStyle
- The unselected style.protected void initLaf(UIManager uim)
Container
public void setPreferredW(int preferredW)
setPreferredW
in class Component
preferredW
- the preferred width of the componentComponent.setPreferredSize(com.codename1.ui.geom.Dimension)
public int getPreferredW()
getPreferredW
in class Component
Component.getPreferredSize()
public Component getIconStyleComponent()
getIconStyleComponent
in interface IconHolder
public TextArea getTextComponent()
public void setUIID(String id)
Component
public void setTextUIID(String uiid)
uiid
- the uiidpublic String getTextUIID()
public Style getTextAllStyles()
public Style getTextUnselectedStyle()
public void setTextUnselectedStyle(Style t)
t
- the style objectpublic Style getTextSelectedStyle()
public void setTextSelectedStyle(Style t)
t
- the style objectpublic void setIconUIID(String uiid)
setIconUIID
in interface IconHolder
uiid
- the uiid for the iconpublic String getIconUIID()
getIconUIID
in interface IconHolder
public void setText(String t)
setText
in interface TextHolder
t
- text of the labelpublic void setIcon(Image i)
setIcon
in interface IconHolder
i
- the iconpublic void setIconValign(int align)
Component.CENTER
align
- One of Component.TOP
, Component.BOTTOM
, or Component.CENTER
.public int getIconValign()
Component.TOP
, Component.BOTTOM
, or Component.CENTER
.public String getText()
getText
in interface TextHolder
public void setTextBlockAlign(int align)
align
- valid values are Component.LEFT, Component.RIGHT, Component.CENTER. Anything else will
stretch the text blockpublic int getTextBlockAlign()
public Image getIcon()
getIcon
in interface IconHolder
public void setIconPosition(String t)
t
- position either North/South/East/Westpublic String getIconPosition()
public String[] getPropertyNames()
getPropertyNames
in class Component
public Class[] getPropertyTypes()
getPropertyTypes
in class Component
public String[] getPropertyTypeNames()
getPropertyTypeNames
in class Component
public Object getPropertyValue(String name)
getPropertyValue
in class Component
name
- the name of the propertypublic String setPropertyValue(String name, Object value)
setPropertyValue
in class Component
name
- the name of the propertyvalue
- new value for the propertypublic boolean isShouldLocalize()
public void setShouldLocalize(boolean shouldLocalize)
shouldLocalize
- the shouldLocalize to setpublic void setTextSelectionEnabled(boolean enabled)
enabled
- True to enable text selection on this label.public boolean isTextSelectionEnabled()
Form#getTextSelection()
,
TextSelection#setEnabled(boolean)
public void setWidth(int width)
setWidth
in class Component
width
- the width of the componentComponent.setPreferredSize(com.codename1.ui.geom.Dimension)
public void setGap(int gap)
setGap
in interface IconHolder
gap
- the gap in pixelspublic int getGap()
getGap
in interface IconHolder
public void setTextPosition(int textPosition)
setTextPosition
in interface IconHolder
textPosition
- alignment value (LEFT, RIGHT, BOTTOM or TOP)#LEFT
,
#RIGHT
,
#BOTTOM
,
#TOP
public int getTextPosition()
getTextPosition
in interface IconHolder
#LEFT
,
#RIGHT
,
#BOTTOM
,
#TOP
public void setMaterialIcon(char c)
FontImage.setMaterialIcon(com.codename1.ui.Label, char)
c
- one of the constants from FontImage
public void setFontIcon(Font font, char c)
com.codename1.ui.FontImage#setMaterialIcon(com.codename1.ui.Label, com.codename1.ui.Font, char)
c
- one of the constants from the fontpublic void setMaterialIcon(char c, float size)
FontImage.setMaterialIcon(com.codename1.ui.Label, char, float)
setMaterialIcon
in interface IconHolder
c
- one of the constants from FontImage
size
- the size of the icon in millimeterspublic void setFontIcon(Font font, char c, float size)
FontImage.setFontIcon(com.codename1.ui.Label, com.codename1.ui.Font, char, float)
setFontIcon
in interface IconHolder
c
- one of the constants from the fontsize
- the size of the icon in millimeterspublic char getMaterialIcon()
public char getFontIcon()
public float getMaterialIconSize()
public float getFontIconSize()
public Font getIconFont()