eve.ui

Class ButtonControl

java.lang.Object

eve.ui.ControlBase

eve.ui.Control

eve.ui.ButtonControl

All Implemented Interfaces:

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

Direct Known Subclasses:

Button, CheckBox

public class ButtonControl
extends Control

This is an intermediate class which is the base for mButtons and mCheckBoxes.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	actionOnPress
int	alignment
int	anchor
int	arrowDirection This allows an optional arrow to be displayed along with the text and icon.
boolean	flatInside
int	imageAnchor
protected boolean	inPress
protected boolean	pressState
boolean	shouldRepeat
boolean	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
ButtonControl()

Method Summary

Modifier and Type	Method and Description
void	activate() This does NOT enable a disabled control - but tells it to put itself in an "active" state.
void	cancelPenPress()
void	deactivate() This does NOT disable a control - but tells it to put itself in a "non-active" state.
void	displayAction(int how)
void	doAction(int how) Do the action as appropriate for this Control - but do not send an Action event.
void	doPenHeld(Point p)
void	doPenPress(Point p)
void	dragged(DragContext dc) This is called during the drag operation.
void	fullAction(int how)
void	fullAction(int how, boolean repaint)
void	gotFocus(int how) This is called when the Control gets the focus.
void	lostFocus(int how) This is called when the Control loses the focus.
void	onLabelPenEvent(PenEvent pe) This is called if the Pen/Mouse is pressed on the Label associated with this Control.
void	penHeld(Point p) Called when the Pen or Mouse button is held down on the control.
void	penPressed(Point p) Called when the Pen or Mouse button is pressed on the control.
void	penReleased(Point p) Called when the Pen or Mouse button is released on the control.
void	penRightReleased(Point p) Called when the right Mouse button is released on the control.
void	startDragging(DragContext dc) This is called to indicate the start of a pen/mouse drag operation.
boolean	startDropMenu(Point p)
void	stopDragging(DragContext dc) Called when the pen was released during a drag operation.

Methods inherited from class eve.ui.Control

acceptsData, addListener, amOnTopFrame, applyFontChange, baseOnPenEvent, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, cache, calculatedSizes, calculateSizes, 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, doPaint, doPaintChildren, doPaintData, 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, notifyAction, 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, setText, setTextSize, setTiledBackgroundImage, setToolTip, showHoldDownIndicator, shown, simulateClickOn, simulateKeyPresses, simulateKeyType, standardOnKeyEvent, startDragAndDrop, startDragAndDrop, takeData, takeFocus, takeFromClipboard, takePromptControl, testInWindowThread, ticked, 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

pressState

protected boolean pressState

inPress

protected boolean inPress

state

public boolean state

shouldRepeat

public boolean shouldRepeat

actionOnPress

public boolean actionOnPress

flatInside

public boolean flatInside

alignment

public int alignment

anchor

public int anchor

imageAnchor

public int imageAnchor

arrowDirection

public int arrowDirection

This allows an optional arrow to be displayed along with the text and icon. If it is 0, then no arrow is displayed. Otherwise it can be set to Up, Down, Left and Right.

Constructor Detail

ButtonControl

public ButtonControl()

Method Detail

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 Control

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 Control

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 Control

Parameters:

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

cancelPenPress

public void cancelPenPress()

Overrides:

cancelPenPress in class Control

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 Control

penHeld

public void penHeld(Point p)

Description copied from class: Control

Called when the Pen or Mouse button is held down on the control. This will only get called if the WantHoldDown modifier has been set for this 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.

This method is usually used to display a context sensitive menu. In fact the default code for it is:

                if (!menuIsActive()) doMenu(p);
        

Overrides:

penHeld in class Control

Parameters:

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

penReleased

public void penReleased(Point p)

Description copied from class: Control

Called when the Pen or Mouse button is released 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:

penReleased in class Control

Parameters:

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

startDragging

public void startDragging(DragContext dc)

Description copied from class: Control

This is called to indicate the start of a pen/mouse drag operation. This will only get called if the WantDrag modifier has been set for this control. Within this method you can call startDragAndDrop() or tryDragAndDrop() to begin a data DragAndDrop operation.

Overrides:

startDragging in class Control

Parameters:

dc - A DragContext indicating information about the dragging.

stopDragging

public void stopDragging(DragContext dc)

Description copied from class: Control

Called when the pen was released during a drag operation. This will only be called if a data DragAndDrop was not initiated and if the cancelled member of the DragContext was not set true during the operation.

Overrides:

stopDragging in class Control

Parameters:

dc - The DragContext for the dragging operation.

fullAction

public void fullAction(int how)

fullAction

public void fullAction(int how,
                       boolean repaint)

displayAction

public void displayAction(int how)

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 Control

Parameters:

how - one of the ByXXX values.

dragged

public void dragged(DragContext dc)

Description copied from class: Control

This is called during the drag operation. It is also called by default by the startDragging() method if you do not override it.

Overrides:

dragged in class Control

Parameters:

dc - The DragContext for the dragging operation.

penRightReleased

public void penRightReleased(Point p)

Description copied from class: Control

Called when the right Mouse button is released 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.

This method is usually used to display a context sensitive menu. In fact the default code for it is:

                if (!menuIsActive()) 
                        if (doMenu(p)) return;
                penReleased(p);
        

Overrides:

penRightReleased in class Control

Parameters:

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

doPenHeld

public void doPenHeld(Point p)

doPenPress

public void doPenPress(Point p)

startDropMenu

public boolean startDropMenu(Point p)

deactivate

public void deactivate()

Description copied from class: Control

This does NOT disable a control - but tells it to put itself in a "non-active" state. For example, a button that has is showing itself as being pressed, will show itself as not pressed when this is called.

If you want to disable a control do modify(Control.Disabled,0)

Overrides:

deactivate in class Control

activate

public void activate()

Description copied from class: Control

This does NOT enable a disabled control - but tells it to put itself in an "active" state. For example, a button in an active state looks as if the mouse/pen is being pressed down on it.

If you want to re-enable a disabled control do modify(0,Control.Disabled)

Overrides:

activate in class Control