totalcross.ui

Class PagePosition

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.PagePosition

Direct Known Subclasses:

NumericPagePosition

public class PagePosition
extends Control

PagePosition implements the empty and filled balls that indicates the current page in a set of pages, very common on Android and iPhone. It has three properties:

1. visible count: the number of visible balls
2. count: the number of balls that will be displayed. Can be less, equal or greater than visible count
3. position: the current position of the filled ball

Since:

TotalCross 1.3

Nested Class Summary

Nested classes/interfaces inherited from class totalcross.ui.Control

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected int	position
protected int	visibleCount

Fields inherited from class totalcross.ui.Control

AFTER, alphaValue, appId, appObj, asContainer, asWindow, backColor, BEFORE, BOTTOM, BOTTOM_OF, BRIGHTER_BACKGROUND, callListenersOnAllTargets, CENTER, CENTER_OF, clearValueInt, clearValueStr, DARKER_BACKGROUND, DP, effect, enableUpdateScreen, esce, eventsEnabled, FILL, fillColor, FIT, floating, fm, fmH, focusHandler, focusLess, focusOnPenDown, focusTraversable, font, FONTSIZE, foreColor, height, ignoreInsets, isHighlighting, isTablet, KEEP, keepDisabled, keepEnabled, LEFT, next, nextTabControl, npParts, offscreen, offscreen0, onEventFirst, parent, PARENTSIZE, PARENTSIZEMAX, PARENTSIZEMIN, PREFERRED, prev, RANGE, repositionAllowed, RIGHT, RIGHT_OF, SAME, SCREENSIZE, SCREENSIZEMAX, SCREENSIZEMIN, setFont, setH, setRel, setW, setX, SETX_NOT_SET, setY, tempW, textShadowColor, TOP, translucentShape, transparentBackground, uiAdjustmentsBasedOnFontHeightIsSupported, uiAndroid, UICONST, uiFlat, uiHolo, uiMaterial, uiVista, visible, width, WILL_RESIZE, x, y

Constructor Summary

Constructors

Constructor and Description
PagePosition(int visibleCount) Constructs a new PagePosition with the given number of visible balls.

Method Summary

Modifier and Type	Method and Description
void	dec(boolean wrap) Decrements the current position.
int	getCount() Returns the ball count.
int	getPosition() Returns the current position
int	getPreferredHeight() Returns the preferred height of this control.
int	getPreferredWidth() Returns the preferred width of this control.
int	getVisibleCount() Returns the visibleCount passed in the constructor.
void	inc(boolean wrap) Increments the current position.
void	onPaint(Graphics g) Called to draw the control.
void	setCount(int c) Sets the balls count.
void	setPosition(int p) Sets the current position (starting at 1).

Methods inherited from class totalcross.ui.Control

_onEvent, addEnabledStateListener, addFocusListener, addFontChangeHandler, addGridListener, addHandler, addHighlightListener, addKeyListener, addListContainerListener, addMouseListener, addMultiTouchListener, addPenListener, addPressListener, addPushNotificationListener, addSizeChangeHandler, addTimer, addTimer, addTimerListener, addValueChangeHandler, addWindowListener, bringToFront, changeHighlighted, clear, contains, drawTranslucentBackground, getAbsoluteRect, getBackColor, getDoEffect, getEffectH, getEffectW, getEffectX, getEffectY, getEventListeners, getFont, getForeColor, getGap, getGraphics, getHeight, getNext, getParent, getParentWindow, getPos, getPressedEvent, getPrev, getRect, getSize, getTextShadowColor, getWidth, getX, getX2, getY, getY2, hadParentScrolled, handleGeographicalFocusChangeKeys, hasFocus, internalSetEnabled, intXYWH, isActionEvent, isChildOf, isDisplayed, isEnabled, isFloating, isInsideOrNear, isObscured, isTopMost, isVisible, isVisibleAndInside, onBoundsChanged, onColorsChanged, onEvent, onFontChanged, onWindowPaintFinished, post, postEvent, postPressedEvent, releaseScreenShot, removeEnabledStateListener, removeFocusListener, removeGridListener, removeHandler, removeHighlightListener, removeKeyListener, removeListContainerListener, removeMouseListener, removeMultiTouchListener, removePenListener, removePressListener, removePushNotificationListener, removeTimer, removeTimerListener, removeWindowListener, repaint, repaintNow, reposition, reposition, repositionChildren, requestFocus, resetSetPositions, resetStyle, safeRepaintNow, safeUpdateScreen, sendToBack, setBackColor, setBackForeColors, setDoEffect, setEnabled, setFloating, setFocusLess, setFont, setForeColor, setNinePatch, setNinePatch, setRect, setRect, setRect, setRect, setSet, setTextShadowColor, setTranslucent, setVisible, showTip, takeInitialScreenShot, takeScreenShot, translateFromOrigin, uiStyleChanged, updateScreen, updateTemporary, willOpenKeyboard

Methods inherited from class java.lang.Object

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

Field Detail

visibleCount

protected int visibleCount

count

protected int count

position

protected int position

Constructor Detail

PagePosition

public PagePosition(int visibleCount)

Constructs a new PagePosition with the given number of visible balls. This number cannot be changed later.

Method Detail

setCount

public void setCount(int c)

Sets the balls count. Invalid values are forced to a valid range.

setPosition

public void setPosition(int p)

Sets the current position (starting at 1). Invalid values are forced to a valid range.

getVisibleCount

public int getVisibleCount()

Returns the visibleCount passed in the constructor.

getCount

public int getCount()

Returns the ball count.

getPosition

public int getPosition()

Returns the current position

inc

public void inc(boolean wrap)

Increments the current position. If wrap is true, when position gets above count, it wraps to 1.

dec

public void dec(boolean wrap)

Decrements the current position. If wrap is true, when position gets below 1, it wraps to count.

onPaint

public void onPaint(Graphics g)

Description copied from class: Control

Called to draw the control. When this method is called, the graphics object passed has been translated into the coordinate system of the control and the area behind the control has already been painted.

Overrides:

onPaint in class Control

Parameters:

g - the graphics object for drawing

See Also:

Graphics

getPreferredWidth

public int getPreferredWidth()

Description copied from class: Control

Returns the preferred width of this control.

Overrides:

getPreferredWidth in class Control

getPreferredHeight

public int getPreferredHeight()

Description copied from class: Control

Returns the preferred height of this control.

Overrides:

getPreferredHeight in class Control