ScaleImageLabel (Codename One API)

java.lang.Object
- com.codename1.ui.Component
- - com.codename1.ui.Label
  - - com.codename1.components.ScaleImageLabel

All Implemented Interfaces:

Animation, Editable, StyleListener, IconHolder, TextHolder
```
public class ScaleImageLabel
extends Label
```
Label that simplifies the usage of scale to fill/fit. This is effectively equivalent to just setting the style image on a label but more convenient for some special circumstances. One major difference is that preferred size equals the image in this case.
The default UIID for this component is "Label".

Constructor Summary

Constructors
Constructor and Description

ScaleImageLabel()
Default constructor

ScaleImageLabel(Image i)
Create a version with the given image

Constructors
Constructor and Description
`ScaleImageLabel()` Default constructor
`ScaleImageLabel(Image i)` Create a version with the given image

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Dimension`	`calcPreferredSize()` Calculates the preferred size based on component content.
`byte`	`getBackgroundType()` Returns the background type for the component
`Image`	`getIcon()` Returns the background image
`int`	`getPreferredH()` Helper method to retrieve the preferred height of the component.
`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
`protected void`	`initComponent()` Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state
`protected void`	`refreshTheme(String id, boolean merge)` Makes sure the component is up to date with the given UIID
`void`	`setBackgroundType(byte behavior)` Sets the behavior of the background to one of Style.BACKGROUND_IMAGE_SCALED_FIT, Style.BACKGROUND_IMAGE_SCALED_FILL, Style.BACKGROUND_IMAGE_SCALE
`void`	`setIcon(Image i)` Instead of setting the icon sets the background image
`void`	`setPreferredH(int preferredH)` Helper method to set the preferred height of the component.
`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`	`setText(String text)` Scale image label doesn't support text this method is overriden to do nothing
`void`	`setUIID(String id)` This method sets the Component the Unique identifier.

Methods inherited from class com.codename1.ui.Label
animate, bindProperty, getAlignment, getBadgeStyleComponent, getBadgeText, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBoundPropertyValue, getDefaultGap, getFontIcon, getFontIconSize, getGap, getIconFont, getIconStyleComponent, getIconUIID, getMask, getMaskedIcon, getMaskName, getMaterialIcon, getMaterialIconSize, getMaxAutoSize, getMinAutoSize, getShiftMillimeters, getShiftMillimetersF, getShiftText, getStringWidth, getText, getTextPosition, getTextSelectionSupport, getVerticalAlignment, initLaf, initUnselectedStyle, isAutoSizeMode, isDefaultTickerEnabled, isEndsWith3Points, isLegacyRenderer, isShouldLocalize, isShowEvenIfBlank, isTextSelectionEnabled, isTickerEnabled, isTickerRunning, laidOut, paint, paramString, refreshTheme, setAlignment, setAutoSizeMode, setBadgeText, setBadgeUIID, setBoundPropertyValue, setDefaultGap, setDefaultTickerEnabled, setEndsWith3Points, setFontIcon, setFontIcon, setFontIcon, setGap, setIconUIID, setLegacyRenderer, setMask, setMaskName, setMaterialIcon, setMaterialIcon, setMaxAutoSize, setMinAutoSize, setShiftMillimeters, setShiftMillimeters, setShiftText, setShouldLocalize, setShowEvenIfBlank, setTextPosition, setTextSelectionEnabled, setTickerEnabled, setVerticalAlignment, shouldTickerStart, startTicker, startTicker, stopTicker, styleChanged, unbindProperty

Methods inherited from class com.codename1.ui.Component
addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, blocksSideSwipe, calcScrollSize, cancelRepaints, clearClientProperties, contains, containsOrOwns, createStyleAnimation, deinitialize, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, dragInitiated, drawDraggedImage, drop, fireClicked, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getAnimationManager, getBorder, getBottomGap, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDefaultDragTransparency, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getDragTransparency, getEditingDelegate, getGridPosX, getGridPosY, 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, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPressedStyle, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getSideGap, getStyle, getTabIndex, getTensileLength, getTooltip, getUIID, getUIManager, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initCustomStyle, initDisabledStyle, initPressedStyle, initSelectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isEnabled, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isPinchBlocksDragAndDrop, isRippleEffect, isRTL, isScrollable, isScrollableX, isScrollableY, isScrollVisible, isSelectableInteraction, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyPressed, keyReleased, keyRepeated, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackground, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setCellRenderer, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, setDropTarget, setEditingDelegate, setEnabled, 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, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPressedStyle, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setShouldCalcPreferredSize, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, toImage, toString, updateNativeOverlay, visibleBoundsContains

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

- Constructor Detail
  - ScaleImageLabel
```
public ScaleImageLabel()
```
    Default constructor
  - ScaleImageLabel
```
public ScaleImageLabel(Image i)
```
    Create a version with the given image
    
    Parameters:
    
    i - image
- Method Detail
  - setBackgroundType
```
public void setBackgroundType(byte behavior)
```
    Sets the behavior of the background to one of Style.BACKGROUND_IMAGE_SCALED_FIT, Style.BACKGROUND_IMAGE_SCALED_FILL, Style.BACKGROUND_IMAGE_SCALE
    
    Parameters:
    
    behavior - the background behavior
  - getBackgroundType
```
public byte getBackgroundType()
```
    Returns the background type for the component
    
    Returns:
    
    One of Style.BACKGROUND_IMAGE_SCALED_FIT, Style.BACKGROUND_IMAGE_SCALED_FILL or Style.BACKGROUND_IMAGE_SCALE
  - calcPreferredSize
```
protected Dimension calcPreferredSize()
```
    Calculates the preferred size based on component content. This method is invoked lazily by getPreferred size.
    
    Overrides:
    
    calcPreferredSize in class Label
    
    Returns:
    
    the calculated preferred size based on component content
  - setIcon
```
public void setIcon(Image i)
```
    Instead of setting the icon sets the background image
    
    Specified by:
    
    setIcon in interface IconHolder
    
    Overrides:
    
    setIcon in class Label
    
    Parameters:
    
    i - the image
  - initComponent
```
protected void initComponent()
```
    Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state Overriden to support animations
    
    Overrides:
    
    initComponent in class Component
  - getIcon
```
public Image getIcon()
```
    Returns the background image
    
    Specified by:
    
    getIcon in interface IconHolder
    
    Overrides:
    
    getIcon in class Label
    
    Returns:
    
    the bg image
  - setText
```
public void setText(String text)
```
    Scale image label doesn't support text this method is overriden to do nothing
    
    Specified by:
    
    setText in interface TextHolder
    
    Overrides:
    
    setText in class Label
    
    Parameters:
    
    text - the string that the label presents.
  - setUIID
```
public void setUIID(String id)
```
    This method sets the Component the Unique identifier. This method should be used before a component has been initialized Overriden to prevent the setUIID from replacing the code
    
    Overrides:
    
    setUIID in class Label
    
    Parameters:
    
    id - UIID unique identifier for component type
  - refreshTheme
```
protected void refreshTheme(String id,
                            boolean merge)
```
    Description copied from class: Component
    
    Makes sure the component is up to date with the given UIID
    
    Overrides:
    
    refreshTheme in class Component
    
    Parameters:
    
    id - The Style Id to update the Component with
    
    merge - indicates if the current styles should be merged with the new styles
  - 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 Label
    
    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 Label
    
    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 Label
    
    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 Label
    
    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 Label
    
    Parameters:
    
    name - the name of the property
    
    value - new value for the property
    
    Returns:
    
    error message or null
  - setPreferredH
```
public void setPreferredH(int preferredH)
```
    Description copied from class: Component
    
    Helper method to set the preferred height of the component.
    
    Overrides:
    
    setPreferredH in class Component
    
    Parameters:
    
    preferredH - the preferred height of the component
    
    See Also:
    
    Component.setPreferredSize(com.codename1.ui.geom.Dimension)
  - setPreferredW
```
public void setPreferredW(int preferredW)
```
    Description copied from class: Component
    
    Helper method to set the preferred width of the component.
    
    Overrides:
    
    setPreferredW in class Component
    
    Parameters:
    
    preferredW - the preferred width of the component
    
    See Also:
    
    Component.setPreferredSize(com.codename1.ui.geom.Dimension)
  - getPreferredH
```
public int getPreferredH()
```
    Description copied from class: Component
    
    Helper method to retrieve the preferred height of the component.
    
    Overrides:
    
    getPreferredH in class Component
    
    Returns:
    
    preferred height of the component
    
    See Also:
    
    Component.getPreferredSize()
  - getPreferredW
```
public int getPreferredW()
```
    Description copied from class: Component
    
    Helper method to retrieve the preferred width of the component.
    
    Overrides:
    
    getPreferredW in class Component
    
    Returns:
    
    preferred width of the component
    
    See Also:
    
    Component.getPreferredSize()

Class ScaleImageLabel

Field Summary

Fields inherited from class com.codename1.ui.Component

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.Label

Methods inherited from class com.codename1.ui.Component

Methods inherited from class java.lang.Object

Constructor Detail

ScaleImageLabel

ScaleImageLabel

Method Detail

setBackgroundType

getBackgroundType

calcPreferredSize

setIcon

initComponent

getIcon

setText

setUIID

refreshTheme

getPropertyNames

getPropertyTypes

getPropertyTypeNames

getPropertyValue

setPropertyValue

setPreferredH

setPreferredW

getPreferredH

getPreferredW