UIObject (JOSH API Document)

java.lang.Object
- org.joshvm.ui.UIObject

Direct Known Subclasses:

AbstractUIObject
```
public abstract class UIObject
extends Object
```
Base UI Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGN_BOTTOM` bottom align
`static int`	`ALIGN_CENTER` center align (used in both horizontal and vertical direction)
`static int`	`ALIGN_DEFAULT` default align
`static int`	`ALIGN_LEFT` left align
`static int`	`ALIGN_RIGHT` right align
`static int`	`ALIGN_TOP` top align
`protected com.joshvm.ui.UIObjectImpl`	`objImpl`
`static int`	`SIDE_BOTTOM` bottom side
`static int`	`SIDE_FULL` all sides
`static int`	`SIDE_LEFT` left side
`static int`	`SIDE_RIGHT` right side
`static int`	`SIDE_TOP` top side
`static int`	`SIZE_CONTENT` Special value for the width or height of ui object.
`static int`	`TEXT_DECOR_NONE` no decoration for text
`static int`	`TEXT_DECOR_STRIKETHROUGH` draw strikethrough for text
`static int`	`TEXT_DECOR_UNDERLINE` draw underline for text

Constructor Summary

Constructors
Modifier Constructor and Description

protected UIObject(com.joshvm.ui.UIObjectImpl obj)

Constructors
Modifier	Constructor and Description
`protected`	`UIObject(com.joshvm.ui.UIObjectImpl obj)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`enableClipCorner(boolean enabled)` Enables to clip the overflowed content on the rounded corner.
`void`	`forceNewTrack(boolean force)` Sets flex new track property of the object.
`Color`	`getBackgroundColor()` Gets background color of the object
`Color`	`getBorderColor()` Gets border color of the object
`int`	`getBorderWidth()` Gets border width of the object.
`int`	`getColumnPadding()` Gets the padding between the columns
`Area`	`getCoordinates()` Gets the coordinates of the object
`int`	`getFlexGrow()` Gets flex grow value of the object.
`int`	`getHeight()` Gets the height of the object.
`int`	`getMaxHeight()` Gets the maximal height of the object.
`int`	`getMaxWidth()` Gets the maximal width of the object.
`int`	`getMinHeight()` Gets the minimal height of the object.
`int`	`getMinWidth()` Gets the minimal width of the object.
`String`	`getName()` Gets the name of the object
`int`	`getPadding(int side)` Gets the padding on specified side.
`protected UIObject`	`getParent()`
`protected boolean`	`getPropertyBooleanValue(int prop)`
`protected int`	`getPropertyIntValue(int prop)`
`int`	`getRadius()` Gets the radius on every corner.
`int`	`getRowPadding()` Gets the padding between the rows
`Color`	`getShadowColor()` Gets shadow color of the object
`int`	`getShadowOffsetX()` Gets the offset on the shadow in X direction.
`int`	`getShadowOffsetY()` Gets the offset on the shadow in X direction.
`int`	`getShadowWidth()` Gets shadow width of the object.
`Color`	`getTextColor()` Gets the color of text of the object.
`int`	`getTextLetterSpace()` Gets the letter space of text of the object
`int`	`getTextLineSpace()` Gets the line space of text of the object
`int`	`getTranslateX()` Returns translate value in X direction
`int`	`getTranslateY()` Returns translate value in Y direction
`Object`	`getUserData()` Gets user data
`int`	`getWidth()` Gets the width of the object.
`int`	`getX()` Gets the X coordinate of the object.
`int`	`getY()` Gets the Y coordinate of the object.
`boolean`	`isClipCornerEnabled()` Returns if enable to clip the overflowed content on the rounded corner.
`void`	`setAlign(int hAlign, int vAlign)` Changes the alignment of the object to its parent.
`void`	`setBackgroundColor(Color color)` Sets background color of the object
`void`	`setBorderColor(Color color)` Sets border color of the object
`void`	`setBorderWidth(int width)` Sets border width of the object.
`void`	`setColumnPadding(int padding)` Sets the padding between the columns
`void`	`setFlexGrow(int value)` Sets flex grow value of the object.
`void`	`setHeight(int h)` Sets the height of the object.
`void`	`setMaxHeight(int h)` Sets a maximal height of the object.
`void`	`setMaxWidth(int w)` Sets a maximal width of the object.
`void`	`setMinHeight(int h)` Sets a minimal height of the object.
`void`	`setMinWidth(int w)` Sets a minimal width of the object.
`void`	`setName(String name)` Sets the name of the object.
`void`	`setPadding(int padding)` Sets the padding on all sides.
`void`	`setPadding(int side, int padding)` Sets the padding on specified sides.
`protected void`	`setParent(UIObject parent)`
`void`	`setPos(int x, int y)` Sets the X coordinate and Y coordinate of the object considering the set align.
`protected void`	`setPropertyValue(int prop, boolean value)`
`protected void`	`setPropertyValue(int prop, int value)`
`protected void`	`setPropertyValue(int prop, int value1, int value2)`
`protected void`	`setPropertyValue(int prop, Object value)`
`void`	`setRadius(int radius)` Sets the radius on every corner.
`void`	`setRecolor(Color color)` Sets the color to mix to image of the object.
`void`	`setRowPadding(int padding)` Sets the padding between the rows
`void`	`setShadowColor(Color color)` Sets shadow color of the object
`void`	`setShadowOffsetX(int offsetX)` Sets an offset on the shadow in X direction.
`void`	`setShadowOffsetY(int offsetY)` Sets an offset on the shadow in Y direction.
`void`	`setShadowWidth(int width)` Sets shadow width of the object.
`void`	`setSize(int width, int height)` Sets the width and height of the object.
`void`	`setTextAlign(int align)` Sets how to align the lines of the text of the object.
`void`	`setTextColor(Color color)` Sets the color of text of the object.
`void`	`setTextDecor(int decor)` Set decoration for the text of the object.
`void`	`setTextFont(Font font)` Sets the font of the text of the object.
`void`	`setTextLetterSpace(int space)` Sets the letter space of text of the object
`void`	`setTextLineSpace(int space)` Sets the line space of text of the object
`void`	`setTranslateX(int translateX)` Move the object with this value in X direction.
`void`	`setTranslateY(int translateY)` Move the object with this value in Y direction.
`void`	`setUserData(Object data)` Sets user data of the object
`void`	`setWidth(int w)` Sets the width of the object.
`void`	`setX(int x)` Sets the X coordinate of the object considering the set align.
`void`	`setY(int y)` Sets the Y coordinate of the object considering the set align.

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

- Field Detail
  - SIDE_LEFT
```
public static final int SIDE_LEFT
```
    left side
    
    See Also:
    Constant Field Values
  - SIDE_RIGHT
```
public static final int SIDE_RIGHT
```
    right side
    
    See Also:
    Constant Field Values
  - SIDE_TOP
```
public static final int SIDE_TOP
```
    top side
    
    See Also:
    Constant Field Values
  - SIDE_BOTTOM
```
public static final int SIDE_BOTTOM
```
    bottom side
    
    See Also:
    Constant Field Values
  - SIDE_FULL
```
public static final int SIDE_FULL
```
    all sides
    
    See Also:
    Constant Field Values
  - SIZE_CONTENT
```
public static final int SIZE_CONTENT
```
    Special value for the width or height of ui object.
    SIZE_CONTENT means that the object will auto change its width or height to fit its own internal content.
    
    See Also:
    Constant Field Values
  - ALIGN_DEFAULT
```
public static final int ALIGN_DEFAULT
```
    default align
    
    See Also:
    Constant Field Values
  - ALIGN_LEFT
```
public static final int ALIGN_LEFT
```
    left align
    
    See Also:
    Constant Field Values
  - ALIGN_TOP
```
public static final int ALIGN_TOP
```
    top align
    
    See Also:
    Constant Field Values
  - ALIGN_CENTER
```
public static final int ALIGN_CENTER
```
    center align (used in both horizontal and vertical direction)
    
    See Also:
    Constant Field Values
  - ALIGN_RIGHT
```
public static final int ALIGN_RIGHT
```
    right align
    
    See Also:
    Constant Field Values
  - ALIGN_BOTTOM
```
public static final int ALIGN_BOTTOM
```
    bottom align
    
    See Also:
    Constant Field Values
  - TEXT_DECOR_NONE
```
public static final int TEXT_DECOR_NONE
```
    no decoration for text
    
    See Also:
    Constant Field Values
  - TEXT_DECOR_UNDERLINE
```
public static final int TEXT_DECOR_UNDERLINE
```
    draw underline for text
    
    See Also:
    Constant Field Values
  - TEXT_DECOR_STRIKETHROUGH
```
public static final int TEXT_DECOR_STRIKETHROUGH
```
    draw strikethrough for text
    
    See Also:
    Constant Field Values
  - objImpl
```
protected com.joshvm.ui.UIObjectImpl objImpl
```
- Constructor Detail
  - UIObject
```
protected UIObject(com.joshvm.ui.UIObjectImpl obj)
```
- Method Detail
  - setParent
```
protected void setParent(UIObject parent)
```
  - getParent
```
protected UIObject getParent()
```
  - setName
```
public void setName(String name)
```
    Sets the name of the object.
    Default name is null.
    
    Parameters:
    name - the new name of the object
  - getName
```
public String getName()
```
    Gets the name of the object
    
    Returns:
    the name that user sets
    See Also:
    setName(java.lang.String)
  - setUserData
```
public void setUserData(Object data)
```
    Sets user data of the object
    
    Parameters:
    data - additional info that user may set
  - getUserData
```
public Object getUserData()
```
    Gets user data
    
    Returns:
    user data
    See Also:
    setUserData(java.lang.Object)
  - setPropertyValue
```
protected void setPropertyValue(int prop,
                    int value)
```
  - setPropertyValue
```
protected void setPropertyValue(int prop,
                    boolean value)
```
  - setPropertyValue
```
protected void setPropertyValue(int prop,
                    int value1,
                    int value2)
```
  - setPropertyValue
```
protected void setPropertyValue(int prop,
                    Object value)
```
  - getPropertyIntValue
```
protected int getPropertyIntValue(int prop)
```
  - getPropertyBooleanValue
```
protected boolean getPropertyBooleanValue(int prop)
```
  - setBackgroundColor
```
public void setBackgroundColor(Color color)
```
    Sets background color of the object
    
    Parameters:
    color - Color instance
    See Also:
    Color
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Gets background color of the object
    Note: the returned value is not guaranteed to be identical to value from the original source, i.e. setBackgroundColor. Color values may be resampled to reflect the display capabilities of the device.
    
    Returns:
    Color instance
  - setBorderWidth
```
public void setBorderWidth(int width)
```
    Sets border width of the object.
    
    Parameters:
    width - in pixels.
  - getBorderWidth
```
public int getBorderWidth()
```
    Gets border width of the object.
  - setBorderColor
```
public void setBorderColor(Color color)
```
    Sets border color of the object
    
    Parameters:
    color - Color instance
  - getBorderColor
```
public Color getBorderColor()
```
    Gets border color of the object
  - setShadowWidth
```
public void setShadowWidth(int width)
```
    Sets shadow width of the object.
    
    Parameters:
    width - in pixels. should >= 0
  - getShadowWidth
```
public int getShadowWidth()
```
    Gets shadow width of the object.
  - setShadowColor
```
public void setShadowColor(Color color)
```
    Sets shadow color of the object
    
    Parameters:
    color - Color instance
  - getShadowColor
```
public Color getShadowColor()
```
    Gets shadow color of the object
  - setShadowOffsetX
```
public void setShadowOffsetX(int offsetX)
```
    Sets an offset on the shadow in X direction.
    
    Parameters:
    offsetX - in pixels.
  - getShadowOffsetX
```
public int getShadowOffsetX()
```
    Gets the offset on the shadow in X direction.
  - setShadowOffsetY
```
public void setShadowOffsetY(int offsetY)
```
    Sets an offset on the shadow in Y direction.
    
    Parameters:
    offsetY - in pixels.
  - getShadowOffsetY
```
public int getShadowOffsetY()
```
    Gets the offset on the shadow in X direction.
  - setRadius
```
public void setRadius(int radius)
```
    Sets the radius on every corner.
    
    Parameters:
    radius - in pixels.
  - getRadius
```
public int getRadius()
```
    Gets the radius on every corner.
  - enableClipCorner
```
public void enableClipCorner(boolean enabled)
```
    Enables to clip the overflowed content on the rounded corner.
    
    Parameters:
    enabled - true or false
  - isClipCornerEnabled
```
public boolean isClipCornerEnabled()
```
    Returns if enable to clip the overflowed content on the rounded corner.
  - setWidth
```
public void setWidth(int w)
```
    Sets the width of the object.
    The width means the total size of border, padding and content area in horizontal direction.
    
    Parameters:
    w - width in pixels or SIZE_CONTENT.
    See Also:
    SIZE_CONTENT
  - getWidth
```
public int getWidth()
```
    Gets the width of the object.
    Returns actual width in pixels in default state.
  - setHeight
```
public void setHeight(int h)
```
    Sets the height of the object.
    The height means the total size of border, padding and content area in vertical direction.
    
    Parameters:
    h - height in pixels or SIZE_CONTENT.
    See Also:
    SIZE_CONTENT
  - getHeight
```
public int getHeight()
```
    Gets the height of the object.
    Returns actual height in pixels in default state.
  - setMinWidth
```
public void setMinWidth(int w)
```
    Sets a minimal width of the object.
    
    Parameters:
    w - width in pixels
  - getMinWidth
```
public int getMinWidth()
```
    Gets the minimal width of the object.
  - setMaxWidth
```
public void setMaxWidth(int w)
```
    Sets a maximal width of the object.
    
    Parameters:
    w - width in pixels
  - getMaxWidth
```
public int getMaxWidth()
```
    Gets the maximal width of the object.
  - setMinHeight
```
public void setMinHeight(int h)
```
    Sets a minimal height of the object.
    
    Parameters:
    h - height in pixels
  - getMinHeight
```
public int getMinHeight()
```
    Gets the minimal height of the object.
  - setMaxHeight
```
public void setMaxHeight(int h)
```
    Sets a maximal height of the object.
    
    Parameters:
    h - height in pixels
  - getMaxHeight
```
public int getMaxHeight()
```
    Gets the maximal height of the object.
  - setPadding
```
public void setPadding(int padding)
```
    Sets the padding on all sides.
    Padding is the spacing between the parent's sides and the children and among the children.
    
    Parameters:
    padding - in pixels.
  - setPadding
```
public void setPadding(int side,
              int padding)
```
    Sets the padding on specified sides.
    
    Parameters:
    side - a combination of SIDE_LEFT, SIDE_RIGHT, SIDE_TOP and SIDE_BOTTOM
    padding - in pixels.
  - getPadding
```
public int getPadding(int side)
```
    Gets the padding on specified side.
    
    Parameters:
    side - SIDE_LEFT or SIDE_RIGHT or SIDE_TOP or SIDE_BOTTOM
  - setX
```
public void setX(int x)
```
    Sets the X coordinate of the object considering the set align.
    The coordinate is relative to parent's content area.
    
    Parameters:
    x - in pixels.
  - getX
```
public int getX()
```
    Gets the X coordinate of the object.
    Not considering the set align in default state, considering the set align in the other states.
  - setY
```
public void setY(int y)
```
    Sets the Y coordinate of the object considering the set align.
    The coordinate is relative to parent's content area.
    
    Parameters:
    y - in pixels.
  - getY
```
public int getY()
```
    Gets the Y coordinate of the object.
    Not considering the set align in default state, considering the set align in the other states.
  - setSize
```
public void setSize(int width,
           int height)
```
    Sets the width and height of the object.
    
    Parameters:
    width - width in pixels or SIZE_CONTENT.
    height - height in pixels or SIZE_CONTENT.
    See Also:
    SIZE_CONTENT
  - setPos
```
public void setPos(int x,
          int y)
```
    Sets the X coordinate and Y coordinate of the object considering the set align.
    
    Parameters:
    x - X coordinate in pixels.
    y - Y coordinate in pixels.
  - getCoordinates
```
public Area getCoordinates()
```
    Gets the coordinates of the object
    
    Returns:
    Area instance
  - setAlign
```
public void setAlign(int hAlign,
            int vAlign)
```
    Changes the alignment of the object to its parent.
    
    Parameters:
    hAlign - alignment in horizontal direction.
    ALIGN_DEFAULT or ALIGN_LEFT or ALIGN_CENTER or ALIGN_RIGHT
    vAlign - alignment in vertical direction.
    ALIGN_DEFAULT or ALIGN_TOP or ALIGN_CENTER or ALIGN_BOTTOM
  - setTranslateX
```
public void setTranslateX(int translateX)
```
    Move the object with this value in X direction. Applied after layouts, aligns and other positioning.
    
    Parameters:
    translateX - in pixels.
  - getTranslateX
```
public int getTranslateX()
```
    Returns translate value in X direction
  - setTranslateY
```
public void setTranslateY(int translateY)
```
    Move the object with this value in Y direction. Applied after layouts, aligns and other positioning.
    
    Parameters:
    translateY - in pixels.
  - getTranslateY
```
public int getTranslateY()
```
    Returns translate value in Y direction
  - setRecolor
```
public void setRecolor(Color color)
```
    Sets the color to mix to image of the object.
    
    Parameters:
    color - Color instance
  - setTextColor
```
public void setTextColor(Color color)
```
    Sets the color of text of the object.
    
    Parameters:
    color - Color instance
  - getTextColor
```
public Color getTextColor()
```
    Gets the color of text of the object.
  - setTextLetterSpace
```
public void setTextLetterSpace(int space)
```
    Sets the letter space of text of the object
    
    Parameters:
    space - in pixels.
  - getTextLetterSpace
```
public int getTextLetterSpace()
```
    Gets the letter space of text of the object
  - setTextLineSpace
```
public void setTextLineSpace(int space)
```
    Sets the line space of text of the object
    
    Parameters:
    space - in pixels.
  - getTextLineSpace
```
public int getTextLineSpace()
```
    Gets the line space of text of the object
  - setTextAlign
```
public void setTextAlign(int align)
```
    Sets how to align the lines of the text of the object.
    
    Parameters:
    align - ALIGN_DEFAULT or ALIGN_LEFT or ALIGN_CENTER or ALIGN_RIGHT
  - setTextFont
```
public void setTextFont(Font font)
```
    Sets the font of the text of the object.
    
    Parameters:
    font - Font instance
    See Also:
    Font
  - setTextDecor
```
public void setTextDecor(int decor)
```
    Set decoration for the text of the object.
    
    Parameters:
    decor - a combination of TEXT_DECOR_NONE, TEXT_DECOR_UNDERLINE and TEXT_DECOR_STRIKETHROUGH
  - setFlexGrow
```
public void setFlexGrow(int value)
```
    Sets flex grow value of the object.
    Flex grow can be used to make one or more children fill the available space on the track. When more children have grow parameters, the available space will be distributed proportionally to the grow values.
    Take effect when parent uses Flex layout.
    
    Parameters:
    value - >= 0
    See Also:
    Flex
  - getFlexGrow
```
public int getFlexGrow()
```
    Gets flex grow value of the object.
  - forceNewTrack
```
public void forceNewTrack(boolean force)
```
    Sets flex new track property of the object.
    Use this property to force Flex to put the object into a new line.
    Take effect when parent uses Flex layout.
    
    Parameters:
    force - true to enable, false to disable
  - setRowPadding
```
public void setRowPadding(int padding)
```
    Sets the padding between the rows
    Used by the layouts.
    
    Parameters:
    padding - >= 0
  - getRowPadding
```
public int getRowPadding()
```
    Gets the padding between the rows
  - setColumnPadding
```
public void setColumnPadding(int padding)
```
    Sets the padding between the columns
    Used by the layouts.
    
    Parameters:
    padding - >= 0
  - getColumnPadding
```
public int getColumnPadding()
```
    Gets the padding between the columns

Class UIObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIDE_LEFT

SIDE_RIGHT

SIDE_TOP

SIDE_BOTTOM

SIDE_FULL

SIZE_CONTENT

ALIGN_DEFAULT

ALIGN_LEFT

ALIGN_TOP

ALIGN_CENTER

ALIGN_RIGHT

ALIGN_BOTTOM

TEXT_DECOR_NONE

TEXT_DECOR_UNDERLINE

TEXT_DECOR_STRIKETHROUGH

objImpl

Constructor Detail

UIObject

Method Detail

setParent

getParent

setName

getName

setUserData

getUserData

setPropertyValue

setPropertyValue

setPropertyValue

setPropertyValue

getPropertyIntValue

getPropertyBooleanValue

setBackgroundColor

getBackgroundColor

setBorderWidth

getBorderWidth

setBorderColor

getBorderColor

setShadowWidth

getShadowWidth

setShadowColor

getShadowColor

setShadowOffsetX

getShadowOffsetX

setShadowOffsetY

getShadowOffsetY

setRadius

getRadius

enableClipCorner

isClipCornerEnabled

setWidth

getWidth

setHeight

getHeight

setMinWidth

getMinWidth

setMaxWidth

getMaxWidth

setMinHeight

getMinHeight

setMaxHeight

getMaxHeight

setPadding

setPadding

getPadding

setX

getX

setY

getY

setSize

setPos

getCoordinates

setAlign

setTranslateX

getTranslateX