org.joshvm.ui

Class AbstractUIObject

java.lang.Object

org.joshvm.ui.UIObject

org.joshvm.ui.AbstractUIObject

Direct Known Subclasses:

Container, Widget

public abstract class AbstractUIObject
extends UIObject

Abstract UI object with more properties

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCROLL_DIR_ALL Allow scroll any directions, i.e.
static int	SCROLL_DIR_BOTTOM Allow scroll down
static int	SCROLL_DIR_HORIZONTAL Allow scroll horizontally, i.e.
static int	SCROLL_DIR_LEFT Allow scroll left
static int	SCROLL_DIR_NONE Disallow scroll
static int	SCROLL_DIR_RIGHT Allow scroll right
static int	SCROLL_DIR_TOP Allow scroll up
static int	SCROLL_DIR_VERTICAL Allow scroll vertically, i.e.
static int	SCROLLBAR_MODE_ACTIVE Show scroll bars when object is being scrolled
static int	SCROLLBAR_MODE_AUTO Show scroll bars when the content is large enough to be scrolled
static int	SCROLLBAR_MODE_OFF Never show scrollbars
static int	SCROLLBAR_MODE_ON Always show scrollbars
static int	STATE_CHECKED Toggled or checked state
static int	STATE_DEFAULT Normal, released state
static int	STATE_DISABLED Disabled state
static int	STATE_SCROLLED Being scrolled

Fields inherited from class org.joshvm.ui.UIObject

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_TOP, objImpl, SIDE_BOTTOM, SIDE_FULL, SIDE_LEFT, SIDE_RIGHT, SIDE_TOP, SIZE_CONTENT, TEXT_DECOR_NONE, TEXT_DECOR_STRIKETHROUGH, TEXT_DECOR_UNDERLINE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUIObject(com.joshvm.ui.UIObjectImpl obj)

Method Summary

Methods

Modifier and Type	Method and Description
UIObject	getObjectOfState(int state) Gets a virtual ui object which represents the object which is in specified state.
UIObject	getScrollbar() Gets a virtual ui object which represents the scrollbar of the object.
int	getScrollbarMode() Returns the scrollbar mode of the object.
UIObject	getScrollbarOfState(int state) Gets a virtual ui object which represents the scrollbar of the object in specified state.
int	getScrollBottom() Return the height of the area below the object.
int	getScrollDirection() Returns the scroll direction of the object.
int	getScrollLeft() Return the width of the area on the left of the object.
int	getScrollRight() Return the width of the area on the right of the object.
int	getScrollTop() Returns the height of the area above the object.
int	getScrollX() Gets current X scroll position.
int	getScrollY() Gets current Y scroll position.
boolean	isChecked() Returns whether the object is checked
boolean	isClickable() Returns whether the object is clickable
boolean	isDisabled() Returns whether the object is disabled
boolean	isFloating() Returns whether the object is floating
boolean	isHidden() Returns whether the object is hidden
boolean	isIgnoreLayout() Returns whether the object is Ignore Layout
boolean	isScrollable() Returns whether the object is scrollable
boolean	isScrolled() Returns whether the object is being scrolled
void	resetAllListeners() Resets all of listeners of the object
void	scrollToView() Scroll to the object until it becomes visible on its parent
void	scrollToView(boolean immediately) Scroll to the object until it becomes visible on its parent
void	scrollToX(int x) Scrolls to a given X coordinate.
void	scrollToX(int x, boolean immediately) Scrolls to a given X coordinate.
void	scrollToY(int y) Scrolls to a given Y coordinate.
void	scrollToY(int y, boolean immediately) Scrolls to a given Y coordinate.
void	setCancelListener(CancelListener listener) Sets the CancelListener of the object
void	setChecked(boolean checked) Sets the object to checked state or not checked state
void	setClickable(boolean clickable) Makes the object clickable or not clickable by input devices
void	setClickedListener(ClickedListener listener) Sets the ClickedListener of the object
void	setDisabled(boolean disabled) Sets the object to disabled state or not disabled state
void	setFloating(boolean floating) Sets the object Floating or not.
void	setHidden(boolean hidden) Makes the object hidden or visible
void	setIgnoreLayout(boolean ignore) Sets the object Ignore Layout or not.
void	setReadyListener(ReadyListener listener) Sets the ReadyListener of the object
void	setScrollable(boolean scrollable) Makes the object scrollable or not scrollable
void	setScrollbarMode(int mode) Sets the scrollbar mode of the object.
void	setScrollDirection(int direction) Sets the scroll direction of the object.
void	setScrollListener(ScrollListener listener) Sets the ScrollListener of the object
void	setValueChangedListener(ValueChangedListener listener) Sets the ValueChangedListener of the object

Methods inherited from class org.joshvm.ui.UIObject

enableClipCorner, forceNewTrack, getBackgroundColor, getBorderColor, getBorderWidth, getColumnPadding, getCoordinates, getFlexGrow, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getName, getPadding, getParent, getPropertyBooleanValue, getPropertyIntValue, getRadius, getRowPadding, getShadowColor, getShadowOffsetX, getShadowOffsetY, getShadowWidth, getTextColor, getTextLetterSpace, getTextLineSpace, getTranslateX, getTranslateY, getUserData, getWidth, getX, getY, isClipCornerEnabled, setAlign, setBackgroundColor, setBorderColor, setBorderWidth, setColumnPadding, setFlexGrow, setHeight, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setName, setPadding, setPadding, setParent, setPos, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setRadius, setRecolor, setRowPadding, setShadowColor, setShadowOffsetX, setShadowOffsetY, setShadowWidth, setSize, setTextAlign, setTextColor, setTextDecor, setTextFont, setTextLetterSpace, setTextLineSpace, setTranslateX, setTranslateY, setUserData, setWidth, setX, setY

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCROLLBAR_MODE_OFF

public static final int SCROLLBAR_MODE_OFF

Never show scrollbars

See Also:

Constant Field Values

SCROLLBAR_MODE_ON

public static final int SCROLLBAR_MODE_ON

Always show scrollbars

See Also:

Constant Field Values

SCROLLBAR_MODE_ACTIVE

public static final int SCROLLBAR_MODE_ACTIVE

Show scroll bars when object is being scrolled

See Also:

Constant Field Values

SCROLLBAR_MODE_AUTO

public static final int SCROLLBAR_MODE_AUTO

Show scroll bars when the content is large enough to be scrolled

See Also:

Constant Field Values

SCROLL_DIR_NONE

public static final int SCROLL_DIR_NONE

Disallow scroll

See Also:

Constant Field Values

SCROLL_DIR_LEFT

public static final int SCROLL_DIR_LEFT

Allow scroll left

See Also:

Constant Field Values

SCROLL_DIR_RIGHT

public static final int SCROLL_DIR_RIGHT

Allow scroll right

See Also:

Constant Field Values

SCROLL_DIR_TOP

public static final int SCROLL_DIR_TOP

Allow scroll up

See Also:

Constant Field Values

SCROLL_DIR_BOTTOM

public static final int SCROLL_DIR_BOTTOM

Allow scroll down

See Also:

Constant Field Values

SCROLL_DIR_HORIZONTAL

public static final int SCROLL_DIR_HORIZONTAL

Allow scroll horizontally, i.e. SCROLL_DIR_LEFT | SCROLL_DIR_RIGHT

See Also:

Constant Field Values

SCROLL_DIR_VERTICAL

public static final int SCROLL_DIR_VERTICAL

Allow scroll vertically, i.e. SCROLL_DIR_TOP | SCROLL_DIR_BOTTOM

See Also:

Constant Field Values

SCROLL_DIR_ALL

public static final int SCROLL_DIR_ALL

Allow scroll any directions, i.e. SCROLL_DIR_HORIZONTAL | SCROLL_DIR_VERTICAL

See Also:

Constant Field Values

STATE_DEFAULT

public static final int STATE_DEFAULT

Normal, released state

See Also:

Constant Field Values

STATE_CHECKED

public static final int STATE_CHECKED

Toggled or checked state

See Also:

Constant Field Values

STATE_DISABLED

public static final int STATE_DISABLED

Disabled state

See Also:

Constant Field Values

STATE_SCROLLED

public static final int STATE_SCROLLED

Being scrolled

See Also:

Constant Field Values

Constructor Detail

AbstractUIObject

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

Method Detail

setChecked

public void setChecked(boolean checked)

Sets the object to checked state or not checked state

Parameters:

checked - true to be checked, false to be not checked

isChecked

public boolean isChecked()

Returns whether the object is checked

setDisabled

public void setDisabled(boolean disabled)

Sets the object to disabled state or not disabled state

Parameters:

disabled - true to be disabled, false to be not disabled

isDisabled

public boolean isDisabled()

Returns whether the object is disabled

isScrolled

public boolean isScrolled()

Returns whether the object is being scrolled

setHidden

public void setHidden(boolean hidden)

Makes the object hidden or visible

Parameters:

hidden - true to be hidden, false to be visible

isHidden

public boolean isHidden()

Returns whether the object is hidden

setClickable

public void setClickable(boolean clickable)

Makes the object clickable or not clickable by input devices

Parameters:

clickable - true to be clickable, false to be not clickable

isClickable

public boolean isClickable()

Returns whether the object is clickable

setScrollable

public void setScrollable(boolean scrollable)

Makes the object scrollable or not scrollable

Parameters:

scrollable - true to be scrollable, false to be not scrollable

isScrollable

public boolean isScrollable()

Returns whether the object is scrollable

setIgnoreLayout

public void setIgnoreLayout(boolean ignore)

Sets the object Ignore Layout or not.

If set, the object is simply ignored by the layouts. Its coordinates can be set as usual.

Parameters:

ignore - true to set coordinates as usual, false to set by layouts

isIgnoreLayout

public boolean isIgnoreLayout()

Returns whether the object is Ignore Layout

setFloating

public void setFloating(boolean floating)

Sets the object Floating or not.

Floating object will be ignored by the layouts, and will be ignored in SIZE_CONTENT calculations. Also the floating object will not scroll when the parent scrolls.

Parameters:

floating - true to set be floating

isFloating

public boolean isFloating()

Returns whether the object is floating

setValueChangedListener

public void setValueChangedListener(ValueChangedListener listener)

Sets the ValueChangedListener of the object

Parameters:

listener - ValueChangedListener

setClickedListener

public void setClickedListener(ClickedListener listener)

Sets the ClickedListener of the object

Parameters:

listener - ClickedListener

setReadyListener

public void setReadyListener(ReadyListener listener)

Sets the ReadyListener of the object

Parameters:

listener - ReadyListener

setCancelListener

public void setCancelListener(CancelListener listener)

Sets the CancelListener of the object

Parameters:

listener - CancelListener

setScrollListener

public void setScrollListener(ScrollListener listener)

Sets the ScrollListener of the object

Parameters:

listener - ScrollListener

resetAllListeners

public void resetAllListeners()

Resets all of listeners of the object

getObjectOfState

public UIObject getObjectOfState(int state)

Gets a virtual ui object which represents the object which is in specified state.

Can set some properties with the returned object.

Parameters:

state - a combination of states. such as STATE_CHECKED, STATE_SCROLLED, ...

Returns:

UIObject

getScrollbar

public UIObject getScrollbar()

Gets a virtual ui object which represents the scrollbar of the object.

Can set some properties with the returned object.

Returns:

UIObject

getScrollbarOfState

public UIObject getScrollbarOfState(int state)

Gets a virtual ui object which represents the scrollbar of the object in specified state.

Can set some properties with the returned object.

Parameters:

state - a combination of states. such as STATE_CHECKED, STATE_SCROLLED, ...

Returns:

UIObject

setScrollbarMode

public void setScrollbarMode(int mode)

Sets the scrollbar mode of the object.

Parameters:

mode - SCROLLBAR_MODE_OFF or SCROLLBAR_MODE_ON or SCROLLBAR_MODE_ACTIVE or SCROLLBAR_MODE_AUTO

getScrollbarMode

public int getScrollbarMode()

Returns the scrollbar mode of the object.

setScrollDirection

public void setScrollDirection(int direction)

Sets the scroll direction of the object.

Parameters:

direction - SCROLL_DIR_NONE, or a combination of SCROLL_DIR_LEFT, SCROLL_DIR_RIGHT, SCROLL_DIR_TOP and SCROLL_DIR_BOTTOM.

getScrollDirection

public int getScrollDirection()

Returns the scroll direction of the object.

getScrollX

public int getScrollX()

Gets current X scroll position.

Returns:

the current scroll position from the left edge.
If the object is not scrolled return 0
If scrolled return > 0
If scrolled in (elastic scroll) return < 0

getScrollY

public int getScrollY()

Gets current Y scroll position.

Returns:

the current scroll position from the top edge.
If the object is not scrolled return 0
If scrolled return > 0
If scrolled inside return < 0

getScrollLeft

public int getScrollLeft()

Return the width of the area on the left of the object. That is the number of pixels the object can be scrolled right.

Returns:

the scrollable area on the left of the object in pixels

getScrollRight

public int getScrollRight()

Return the width of the area on the right of the object. That is the number of pixels the object can be scrolled left.

Returns:

the scrollable area on the right of the object in pixels

getScrollTop

public int getScrollTop()

Returns the height of the area above the object.

That is the number of pixels the object can be scrolled down.

Returns:

the scrollable area above the object in pixels

getScrollBottom

public int getScrollBottom()

Return the height of the area below the object. That is the number of pixels the object can be scrolled up.

Returns:

the scrollable area below the object in pixels

scrollToX

public void scrollToX(int x)

Scrolls to a given X coordinate.

Parameters:

x - scroll position in pixels

See Also:

getScrollX()

scrollToX

public void scrollToX(int x,
             boolean immediately)

Scrolls to a given X coordinate.

Parameters:

x - scroll position in pixels

immediately - true:scroll immediately, false:scroll with animation

See Also:

getScrollX()

scrollToY

public void scrollToY(int y)

Scrolls to a given Y coordinate.

Parameters:

y - scroll position in pixels

See Also:

getScrollY()

scrollToY

public void scrollToY(int y,
             boolean immediately)

Scrolls to a given Y coordinate.

Parameters:

y - scroll position in pixels

immediately - true:scroll immediately, false:scroll with animation

See Also:

getScrollY()

scrollToView

public void scrollToView()

Scroll to the object until it becomes visible on its parent

scrollToView

public void scrollToView(boolean immediately)

Scroll to the object until it becomes visible on its parent

Parameters:

immediately - true:scroll immediately, false:scroll with animation