totalcross.ui

Class Ruler

java.lang.Object

totalcross.ui.gfx.GfxSurface

totalcross.ui.Control

totalcross.ui.Ruler

public class Ruler
extends Control

Ruler is a horizontal or vertical ruler. Here's an example:

 Ruler r = new Ruler();
 r.invert = true;
 add(r, LEFT,AFTER+2);
 

Nested Class Summary

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

Control.TranslucentShape

Field Summary

Fields

Modifier and Type	Field and Description
boolean	dots Set to true to draw a dotted line instead of a filled line.
static int	HORIZONTAL Defines a HORIZONTAL ruler type.
boolean	invert Set to true to invert the color of the first and second lines.
static int	VERTICAL Defines a VERTICAL ruler type.

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
Ruler() Constructs a 3d horizonal ruler.
Ruler(int type, boolean is3d) Constructs a ruler of the given type.

Method Summary

Modifier and Type	Method and Description
int	getPreferredHeight() For vertical rulers, returns FILL.
int	getPreferredWidth() For horizontal rulers, returns FILL.
void	onColorsChanged(boolean colorsChanged) Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container.
void	onPaint(Graphics g) Called to draw the control.

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, 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

HORIZONTAL

public static final int HORIZONTAL

Defines a HORIZONTAL ruler type.

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

Defines a VERTICAL ruler type.

See Also:

Constant Field Values

invert

public boolean invert

Set to true to invert the color of the first and second lines. Only makes sense if 3d is true.

dots

public boolean dots

Set to true to draw a dotted line instead of a filled line.

Constructor Detail

Ruler

public Ruler()

Constructs a 3d horizonal ruler.

Ruler

public Ruler(int type,
             boolean is3d)

Constructs a ruler of the given type.

Parameters:

type - The type of the ruler.

is3d - Set to false to draw a simple line instead of a 3d one.

See Also:

HORIZONTAL, VERTICAL

Method Detail

getPreferredWidth

public int getPreferredWidth()

For horizontal rulers, returns FILL. Otherwise, returns 2 if is 3d or 1 if its not 3d.

Overrides:

getPreferredWidth in class Control

getPreferredHeight

public int getPreferredHeight()

For vertical rulers, returns FILL. Otherwise, returns 2 if is 3d or 1 if its not 3d.

Overrides:

getPreferredHeight in class Control

onColorsChanged

public void onColorsChanged(boolean colorsChanged)

Description copied from class: Control

Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container. If colorsChanged is true, it was called from setForeColor/setBackColor/Container.add; otherwise, it was called from setEnabled

Overrides:

onColorsChanged in class Control

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