eve.ui

Class CheckBox

java.lang.Object

eve.ui.ControlBase

eve.ui.Control

eve.ui.ButtonControl

eve.ui.CheckBox

All Implemented Interfaces:

Drawable, ImageRefresher, DataInterface, TimerProc, CellConstants, ControlConstants, HasAncestor, UIConstants, Booleanable, EventListener

Direct Known Subclasses:

ButtonCheckBox

public class CheckBox
extends ButtonControl
implements Booleanable

Field Summary

Fields

Modifier and Type	Field and Description
int	boxWidth Deprecated. the box size is now matched to the text size.
static int	defaultBoxWidth Deprecated. the box size is now matched to the text size.
static boolean	defaultUseCross If this is true a checkbox will draw an 'x' instead of a tick.
boolean	dontBlink Set this true to disable blinking of the Checkbox when it gets the keyboard focus.
CheckBoxGroup	group
boolean	useCross If this is true the checkbox will draw an 'x' instead of a tick.

Fields inherited from class eve.ui.ButtonControl

actionOnPress, alignment, anchor, arrowDirection, flatInside, imageAnchor, inPress, pressState, shouldRepeat, state

Fields inherited from class eve.ui.Control

backGround, beforeRemoved, borderColor, borderStyle, borderWidth, children, columns, constraints, curFont, debugModify, debugRepaintNow, disabledBackground, dragging, dragResolution, dragTime, exitKeys, fieldTransfer, font, fontChange, fontFrom, foreGround, height, holdDownPause, holdTick, hotKey, image, lastSelected, listeners, lockPaint, maxHeight, maxWidth, menuState, minHeight, minWidth, modifiers, name, next, parent, penStatus, preferredHeight, preferredWidth, prev, prompt, promptControl, rows, ss, startDragResolution, tags, tail, text, toolTip, width, x, y

Fields inherited from class eve.ui.ControlBase

clipItems, clipObject, clipOwner, debugControl, debugFlag, doubleBuffer, doubleClickTime, doubleSizedFontHeight, firstPress, globalEditable, globalEnabled, PEN_STATUS_DID_HOLD_DOWN, PEN_STATUS_GOT_PEN_DOWN, PEN_STATUS_PEN_IS_ON, pressPoint, TAG_BOOLEAN_KEEP_BELOW_SIP, TAG_HOVER_TIME_INT, TAG_LAST_USER_DATA, TAG_USER_DATA, TAKE_FIRST_PRESS, unnamed

Fields inherited from interface eve.ui.UIConstants

BDR_DOTTED, BDR_INNER, BDR_NOBORDER, BDR_OUTER, BDR_OUTLINE, BDR_RAISEDINNER, BDR_RAISEDOUTER, BDR_SUNKENINNER, BDR_SUNKENOUTER, BF_ABUT_ANY, BF_ABUT_BOTTOM, BF_ABUT_LEFT, BF_ABUT_RIGHT, BF_ABUT_TOP, BF_BOTTOM, BF_BOTTOMLEFT, BF_BOTTOMRIGHT, BF_BUTTON, BF_DIAGONAL, BF_DIAGONAL_ENDBOTTOMLEFT, BF_DIAGONAL_ENDBOTTOMRIGHT, BF_DIAGONAL_ENDTOPLEFT, BF_DIAGONAL_ENDTOPRIGHT, BF_EXACT, BF_FLAT, BF_LEFT, BF_MIDDLE, BF_MONO, BF_PALM, BF_RECT, BF_RIGHT, BF_SOFT, BF_SQUARE, BF_TOP, BF_TOPLEFT, BF_TOPRIGHT, EDGE_BUMP, EDGE_ETCHED, EDGE_RAISED, EDGE_SUNKEN

Fields inherited from interface eve.ui.CellConstants

ALWAYS_STRETCHABLE, BOTTOM, CELLFLAG, CELLMASK, CENTER, CONTROLMASK, DONTCHANGE, DONTFILL, DONTSTRETCH, EAST, FILL, GROW, HCENTER, HCONTRACT, HEXPAND, HFILL, HGROW, HSHRINK, HSTRETCH, INITIALLY_CLOSED, INITIALLY_HIDDEN, INITIALLY_MINIMIZED, INITIALLY_PREFERRED_SIZE, INSETS, LEFT, MAXIMUMSIZE, MINIMUMSIZE, NORTH, NORTHEAST, NORTHWEST, PREFERREDSIZE, RECT, RIGHT, SHRINK, SOUTH, SOUTHEAST, SOUTHWEST, SPAN, STRETCH, TAG_BACKGROUND_IMAGE, TAG_BUSY_DISPLAY, TAG_COLORS, TAG_CONTROL_PAINTER, TAG_EXPOSE_GROUP, TAG_FIXEDSIZE, TAG_GRAY_BACKGROUND, TAG_HIDE_CONTROL_OBJECT, TAG_HIDE_PARENT, TAG_INNER_TEXT_INSETS, TAG_INPUT_STACK_PARENT, TAG_INSETS, TAG_MAKE_VISIBLE, TAG_MAXIMUMSIZE, TAG_MINIMUMSIZE, TAG_PAINT_CONTROL_LIST, TAG_PREFERRED_TEXT_SIZE, TAG_PREFERRED_TEXT_SIZE_HEIGHT, TAG_PREFERRED_TEXT_SIZE_WIDTH, TAG_PREFERREDSIZE, TAG_RECT, TAG_SHADOW_INSETS, TAG_SPAN, TAG_SWIPER, TAG_TEMPORARY_ERROR, TAG_TEXT_INSETS, TAG_TEXTSIZE, TEXTSIZE, TOP, VCENTER, VCONTRACT, VEXPAND, VFILL, VGROW, VSHRINK, VSTRETCH, WEST

Fields inherited from interface eve.ui.ControlConstants

All, AlwaysEnabled, AlwaysRecalculateSizes, ByDeferredMouse, ByDeferredPen, ByFrameChange, ByKeyboard, ByMouse, ByPen, ByRequest, CalculatedSizes, ContainerDontPaintChildren, Disabled, DisablePopupMenu, DisplayOnly, DontBuffer, Down, DrawFlat, Flag, ForceResize, HasData, Invisible, KeepImage, KeepSIP, Left, MakeMenuAtLeastAsWide, Maximize, Minimize, ModifiersInheritedFromWindow, MouseSensitive, NoFocus, NotAnEditor, NotEditable, PaintDataOnly, PaintOutsideOnly, PenTransparent, PreferredSizeOnly, Right, SendUpUIEvents, ShowSIP, ShrinkToNothing, SmallControl, TakeChildUIEvents, TakeControlEvents, TakesKeyFocus, Transparent, Up, WantDrag, WantHoldDown

Fields inherited from interface eve.fx.ImageRefresher

KEEP_VISIBLE

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
CheckBox()
CheckBox(String txt)

Method Summary

Modifier and Type	Method and Description
protected void	calculateSizes() Override this to calculate the preferred, minimum and maximum size of your control.
void	doAction(int how) Do the action as appropriate for this Control - but do not send an Action event.
void	doPaint(Graphics g, Rect area) This is the main method to override when doing custom Control painting.
void	doPaintCircle(Graphics g)
protected void	doPaintData(Graphics g) Repaint the "data" part of the Control.
void	doPaintDiamond(Graphics g)
void	doPaintSquare(Graphics g)
boolean	getState()
void	gotFocus(int how) This is called when the Control gets the focus.
boolean	isExclusive()
void	lostFocus(int how) This is called when the Control loses the focus.
void	notifyAction() Generate and send a standard "action" event for this Control.
void	onLabelPenEvent(PenEvent pe) This is called if the Pen/Mouse is pressed on the Label associated with this Control.
void	penPressed(Point p) Called when the Pen or Mouse button is pressed on the control.
CheckBox	setGroup(CheckBoxGroup cbg) Add this CheckBox to the CheckBoxGroup and return this CheckBox.
void	setState(boolean to)
void	setText(String text) Set the text of the Control, automatically repainting it.
void	ticked(Object id, long elapsed)

Methods inherited from class eve.ui.ButtonControl

activate, cancelPenPress, deactivate, displayAction, doPenHeld, doPenPress, dragged, fullAction, fullAction, penHeld, penReleased, penRightReleased, startDragging, startDropMenu, stopDragging

Methods inherited from class eve.ui.Control

acceptsData, addListener, amOnTopFrame, applyFontChange, baseOnPenEvent, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, cache, calculatedSizes, calculateTextSize, calculateTextSize, calculateTextSize, cancelHoldDown, canEdit, change, changeDimension, changeTag, checkClipboardOperations, checkExitKey, checkMenu, checkMenuKey, checkModifiers, checkParentInterceptsUIEvent, checkPenTransparent, childrenPainted, clearTag, clipboardToString, clipboardTransfer, closeMenu, contains, contains, createNewMenu, dataAccepted, dataBeingRemoved, dataDraggedOff, dataDraggedOver, dataDraggedOver, dataDroppedOn, dataTransferCancelled, defaultTo, deferInWindowThread, doActionKey, doBackground, doBorder, doHotKey, doMenu, dontAcceptDrop, doPaintChildren, doPaintData, doShowMenu, draw, draw, draw, exitEntry, fillBackground, fillBackgroundNotInFrame, findTagInParents, fontChanged, formClosing, free, fromClipboard, fromField, fromField, getAllDescendants, getAllSubControls, getAncestor, getAncestor, getAncestorProperty, getBackground, getCached, getCachedChildren, getCachedDim, getCachedDim, getCachedRect, getCachedRect, getCachedSubControls, getChildAnchor, getChildren, getChildren, getChildrenBackwards, getClipboardMenu, getClipObject, getContentsInsets, getContentsInsets, getContentsRect, getDataToCopy, getDataToDragAndDrop, getDim, getDisplayText, getDragAndDropContext, getFieldTransfer, getFont, getFontMetrics, getFontMetrics, getFontMetricsForSizeCalculations, getForeground, getFrame, getFrameOrContainer, getGraphics, getGraphics, getHeight, getHideParent, getImage, getLastSelected, getLocation, getLock, getMaximumSize, getMenu, getMinimumSize, getModifiedBorderFlags, getModifiers, getNext, getNextKeyFocus, getPaintParameters, getParent, getParent, getParent, getParentOrListener, getPasswordCharacter, getPosInFrame, getPosInFrame, getPosInParent, getPosInParent, getPreferredSize, getPreferredSizeByParent, getPreferredTextSize, getPrompt, getPromptText, getRect, getRect, getServer, getSize, getSizes, getSubControls, getSubControls, getTag, getText, getToolTip, getWidth, getWindow, getWindowGraphics, hasModifier, hasPopupFormAttached, hasTag, hide, inheritModifiers, insetToContents, interceptChildUIEvent, isChildOf, isDirectChildOfWindow, isHidden, isModal, isOnMe, isOnMe, isOnMe, isSomeonesHotKey, make, makeFrameTopMost, makeHot, makeHot, makeInvisible, makeVisible, markAsTemporaryError, menuIsActive, menuStateChanged, modify, modifyAll, modifyAll, modifyFlags, mouseHover, newEventThread, notifyDataChange, notifyDataChange, notifyMenuItemSelected, notifyStructureChanged, onControlEvent, onEvent, onKeyEvent, onPenEvent, paintBackground, paintWithControlPainter, pauseEventThread, penClicked, penDoubleClicked, popupBeep, popupMenuClosed, popupMenuEvent, popupMenuEvent, postEvent, postInWindowThread, postUIEvent, putInside, queueKeyEvent, queuePenEvent, readLock, recalculatePreferredSize, redisplay, refresh, releaseBufferedGraphics, removed, removeListener, repaint, repaint, repaintDataNow, repaintInWindowThread, repaintInWindowThread, repaintNow, repaintNow, repaintNow, repaintNow, requestPaint, requestResizeTo, resetAllCachedProperties, resetCachedProperties, resetRect, resizeTo, restore, restoreBorderModifiers, restoreFlags, resumeEventThread, scrollAndRepaint, sendToListeners, set, setAllFonts, setBackgroundImage, setBorder, setBorderModifiers, setCell, setChildAnchor, setClipObject, setControl, setCursor, setFieldTransfer, setFixedSize, setFont, setFontChange, setFreeDragging, setHidden, setHiddenParent, setHotKey, setHotKey, setLocation, setMaximumSize, setMenu, setMinimumSize, setPreferredSize, setPreferredTextSize, setPreferredTextSize, setPromptControl, setRect, setRect, setScaledBackgroundImage, setServer, setShadow, setSwiping, setTag, setTags, setTextSize, setTiledBackgroundImage, setToolTip, showHoldDownIndicator, shown, simulateClickOn, simulateKeyPresses, simulateKeyType, standardOnKeyEvent, startDragAndDrop, startDragAndDrop, takeData, takeFocus, takeFromClipboard, takePromptControl, testInWindowThread, tipIsDisplayed, toClipboard, toField, toField, toIDString, toString, toTextData, transferPenPress, transferPenPress, tryDragAndDrop, tryGetGraphics, tryNext, tryStartMenu, unhide, unlock, updateData, updateDCDuringDD, updateFrom, updateTo, verifyWantDrag, verifyWantHoldDown, waitEventThread, willAcceptDrop, willShowFrame, windowHasFloatingControls, writeLock

Methods inherited from class eve.ui.ControlBase

doubleSizeIt, getGuiTextHeight, isDoubleSized, isDoubleSizedFont, loadImage, tryLoadImage

Methods inherited from class java.lang.Object

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

Field Detail

dontBlink

public boolean dontBlink

Set this true to disable blinking of the Checkbox when it gets the keyboard focus.

group

public CheckBoxGroup group

defaultBoxWidth

public static int defaultBoxWidth

Deprecated. the box size is now matched to the text size.

This is the default width of the box. By default it is 16.

defaultUseCross

public static boolean defaultUseCross

If this is true a checkbox will draw an 'x' instead of a tick.

boxWidth

public int boxWidth

Deprecated. the box size is now matched to the text size.

This width of the box - this is initialized to defaultBoxWidth.

useCross

public boolean useCross

If this is true the checkbox will draw an 'x' instead of a tick. It is initialized to defaultUseCross;

Constructor Detail

CheckBox

public CheckBox()

CheckBox

public CheckBox(String txt)

Method Detail

onLabelPenEvent

public void onLabelPenEvent(PenEvent pe)

Description copied from class: Control

This is called if the Pen/Mouse is pressed on the Label associated with this Control.

Overrides:

onLabelPenEvent in class ButtonControl

gotFocus

public void gotFocus(int how)

Description copied from class: Control

This is called when the Control gets the focus. The default version of this does nothing.

Overrides:

gotFocus in class ButtonControl

Parameters:

how - one of the ByXXX values.

lostFocus

public void lostFocus(int how)

Description copied from class: Control

This is called when the Control loses the focus. The default version of this does nothing.

Overrides:

lostFocus in class ButtonControl

Parameters:

how - one of the ByXXX values.

penPressed

public void penPressed(Point p)

Description copied from class: Control

Called when the Pen or Mouse button is pressed on the control. This is called by the onPenEvent(PenEvent ev) method.

Within this method you can use the Control.Gui.currentPenPress() value to find out more about the PenEvent that caused this - including any modifiers (e.g. SHIFT keys) or determine if the left or right mouse button was pressed.

Overrides:

penPressed in class ButtonControl

Parameters:

p - The point on the Control where the pen was pressed.

ticked

public void ticked(Object id,
                   long elapsed)

Specified by:

ticked in interface TimerProc

Overrides:

ticked in class Control

calculateSizes

protected void calculateSizes()

Description copied from class: Control

Override this to calculate the preferred, minimum and maximum size of your control. This is only called once unless the modifier flag AlwaysRecalculateSizes is true. During the calculation you will set the variables preferredWidth, preferredHeight, etc. directly.

Overrides:

calculateSizes in class Control

isExclusive

public boolean isExclusive()

doPaint

public void doPaint(Graphics g,
                    Rect area)

Description copied from class: Control

This is the main method to override when doing custom Control painting. It is called when the Control needs refreshing or when repaintNow() is called.

Overrides:

doPaint in class Control

Parameters:

g - the graphics to paint to.

area - the area within the Control to paint. This can be ignored and the entire area can be painted if so desired.

doPaintData

protected void doPaintData(Graphics g)

Description copied from class: Control

Repaint the "data" part of the Control. This is only used for Controls with the HasData modifier. These are controls that distinguish between their data (e.g. contained text) and non-data (e.g. border) on-screen display.

Overrides:

doPaintData in class Control

Parameters:

g - The Graphics object to paint to.

doPaintSquare

public void doPaintSquare(Graphics g)

doPaintCircle

public void doPaintCircle(Graphics g)

doPaintDiamond

public void doPaintDiamond(Graphics g)

getState

public boolean getState()

Specified by:

getState in interface Booleanable

setState

public void setState(boolean to)

Specified by:

setState in interface Booleanable

doAction

public void doAction(int how)

Description copied from class: Control

Do the action as appropriate for this Control - but do not send an Action event. By default this does nothing.

Overrides:

doAction in class ButtonControl

Parameters:

how - one of the ByXXX values.

setGroup

public CheckBox setGroup(CheckBoxGroup cbg)

Add this CheckBox to the CheckBoxGroup and return this CheckBox.

Parameters:

cbg - the Group to add to.

Returns:

this CheckBox.

setText

public void setText(String text)

Description copied from class: Control

Set the text of the Control, automatically repainting it.

Overrides:

setText in class Control

notifyAction

public void notifyAction()

Description copied from class: Control

Generate and send a standard "action" event for this Control.

Overrides:

notifyAction in class Control