ewe.ui
Class InputKeyPad

java.lang.Object
  ewe.ui.ControlBase
      ewe.ui.Control
          ewe.ui.Container
              ewe.ui.Canvas
                  ewe.ui.Panel
                      ewe.ui.CellPanel
                          ewe.ui.FormBase
                              ewe.ui.Form
                                  ewe.ui.ControlPopupForm
                                      ewe.ui.InputKeyPad

All Implemented Interfaces:

CellConstants, ControlConstants, EventListener, HasProperties, ImageRefresher, IScroll, LayoutManager, PopupController, ScrollClient, TimerProc, UIConstants

Direct Known Subclasses:

DecimalKeyPad, NumericKeyPad

public class InputKeyPad

extends ControlPopupForm

Field Summary

CellPanel	bottom
mButton	clear
mLabel	curText
boolean	isPassword
CellPanel	keys
char	passwordCharacter
mButton	reset
boolean	showClientTextFirst
boolean	showPrompt Set this true to show a prompt at the top of the InputKeyPad.
CellPanel	top
protected String	value

Fields inherited from class ewe.ui.ControlPopupForm

attachedTo, client, closeIfPressClient, putByClient

Fields inherited from class ewe.ui.Form

acceptsDroppedFiles, apply, back, buttons, BUTTONS_TO_SOFT_KEY_FIRST_BUTTON_SEPARATE, BUTTONS_TO_SOFT_KEY_MENU_ALWAYS, BUTTONS_TO_SOFT_KEY_USE_FIRST_SOFT_KEY, buttonsPanel, buttonsPerRow, cancel, deflt, dismantleOnClose, exitButtonDefined, exitSystemOnClose, exitValue, firstFocus, formFrame, globalIcon, handle, hasTopBar, keepFrame, moveable, no, noBorder, ok, pl, resizable, resizeOnSIP, taskbarIcon, titleCancel, titleControls, titleOK, topControls, untitledTitle, windowFlagsToClear, windowFlagsToSet, windowIcon, windowTitle, yes

Fields inherited from class ewe.ui.FormBase

BACKB, CANCELB, close, cross, defaultShowOptions, DEFCANCELB, DEFOKB, EXIT_IDBACK, EXIT_IDCANCEL, EXIT_IDNO, EXIT_IDOK, EXIT_IDYES, IDBACK, IDCANCEL, IDNO, IDOK, IDYES, MBB, MBNONE, MBOK, MBOKCANCEL, MBYESNO, MBYESNOCANCEL, NOB, OKB, stop, tick, tools, YESB

Fields inherited from class ewe.ui.CellPanel

autoSpan, equalHeights, equalWidths, layout, mySplitter, nextSplitter, quickRecalculate

Fields inherited from class ewe.ui.Panel

all, backgroundImage, calculated, childListeners, defaultAddToMeCellConstraints, defaultTags, grid, lastAdded, layoutManager, made, noInsets, stretchFirstColumn, stretchFirstRow, stretchLastColumn, stretchLastRow, titleGap

Fields inherited from class ewe.ui.Canvas

isFullScrollClient, origin, scrollPercent, virtualSize

Fields inherited from class ewe.ui.Container

closedFocus, cycleFocus, dontAutoScroll, dontFocusOnChildren

Fields inherited from class ewe.ui.Control

_debug, backGround, beforeRemoved, borderColor, borderStyle, borderWidth, children, columns, constraints, DoPaintMethod, dragging, dragResolution, dragTime, exitKeys, fieldTransfer, font, foreGround, haveNativePaint, height, holdDownPause, holdTick, hotKey, image, lastSelected, listeners, maxHeight, maxWidth, menuState, minHeight, minWidth, modifiers, MyClass, name, next, np, parent, penStatus, popupSound, popupSoundClip, preferredHeight, preferredWidth, prev, prompt, promptControl, rows, ss, standardBorder, standardEdge, startDragResolution, tags, tail, text, toolTip, width, x, y

Fields inherited from class ewe.ui.ControlBase

clipItems, clipObject, clipOwner, curPoint, currentPenEvent, debugControl, debugFlag, DidHoldDown, doubleBuffer, doubleClickTime, firstPress, globalDrawFlat, globalEditable, globalEnabled, globalPalmStyle, globalSmallControls, GotPenDown, PenIsOn, pressPoint, TAG_LAST_USER_DATA, TAG_USER_DATA, TAKE_FIRST_PRESS, unnamed, useNativeTextInput

Fields inherited from interface ewe.ui.PopupController

CLOSE_FOR_NEW_POPUP, FLAG_NEW_POPUP_IS_MENU

Fields inherited from interface ewe.ui.CellConstants

BORDER, BOTTOM, CELLFLAG, CELLMASK, CENTER, CONTROLMASK, DONTCHANGE, DONTFILL, DONTSTRETCH, EAST, FILL, FIXEDSIZE, GROW, HCENTER, HCONTRACT, HEXPAND, HFILL, HGROW, HSHRINK, HSTRETCH, INITIALLY_CLOSED, INITIALLY_MINIMIZED, INITIALLY_PREFERRED_SIZE, INSETS, LEFT, MAXIMUMSIZE, MINIMUMSIZE, NORTH, NORTHEAST, NORTHWEST, PREFERREDSIZE, RECT, RIGHT, SHRINK, SOUTH, SOUTHEAST, SOUTHWEST, SPAN, STRETCH, TEXTSIZE, TOP, VCENTER, VCONTRACT, VEXPAND, VFILL, VGROW, VSHRINK, VSTRETCH, WEST

Fields inherited from interface ewe.ui.IScroll

Higher, Horizontal, Lower, OPTION_INDICATOR_ONLY, PageHigher, PageLower, ScrollHigher, ScrollLower, TrackTo, Vertical

Fields inherited from interface ewe.ui.UIConstants

BDR_DOTTED, BDR_INNER, BDR_NOBORDER, BDR_OUTER, BDR_OUTLINE, BDR_RAISEDINNER, BDR_RAISEDOUTER, BDR_SUNKENINNER, BDR_SUNKENOUTER, 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 ewe.ui.ControlConstants

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

Fields inherited from interface ewe.fx.ImageRefresher

KEEP_VISIBLE

Constructor Summary

InputKeyPad()

Method Summary

protected void	append(String what)
boolean	canExit(int exitCode) This is called by the exit() method to see if the form can be closed.
protected boolean	canExitWithValue(String value) If this returns false then the InputKeyPad will not exit with a code of IDOK.
void	close(int exitCode) This closes the form unconditionally and sets the exitValue to be exitCode.
protected void	doClear() By default this does nothing.
protected void	doInit() This is called after the call to popup().
protected void	doReset() This should reset the Form for input.
protected String	fixValue(String value, String oldValue) A call to setValue() will then call this method to validate the entered text.
String	getDisplayText() This gets the String to represent on screen the data String provided.
FormFrame	getFormFrame(int options) This is called when the Form is about to be displayed.
protected String	getTextForClient() Get the text to transfer back to the client.
void	make(boolean reMake) This is used to "make" the control before being displayed.
void	onControlEvent(ControlEvent ev) This listens for ControlEvent.PRESSED events from attached controls and calls setFor(Control who) if it detects that event.
protected void	pressed(Control who)
void	refresh() Re-display the text.
protected void	setValue(String text)
protected void	startingInput(Control c) This is where the size of the input is selected (to match the number of columns in the client) and where isPassword is set.
protected void	transferToClient(Control client) This is called if the exit value of the Form is IDOK - it is used to indicate that data should be transferred to the client control if necessary.

Methods inherited from class ewe.ui.ControlPopupForm

addCloseControls, addCloseControls, addMainControls, attachTo, checkSize, closePopup, detachFrom, makeFrame, onKeyEvent, popup, pressedOutside, setFor

Methods inherited from class ewe.ui.Form

_getSetField, addButton, addTabbedPanel, addToolbar, buttonsToMenu, buttonsToSoftKeyBar, buttonsToSoftKeyBar, cancelWait, checkButtons, closeAll, closeForTransfer, closeForTransfer, continueWait, createMenuItem, createMenuItem, createMenuItem, createWindow, defaultTitleTo, dismantle, doButtons, doShowExec, exec, exec, exec, exec, exec, exec, exec, exec, exec, execute, execute, execute, exit, filesDropped, formClosing, formShown, gatherButtons, getButton, getFirstFocus, getProperties, getSoftKeyBarFor, getTopmostForm, handleAction, handleAction, hasExitButton, makeButtonForForm, makeButtonForForm, makeDefaultButton, makeDefaultButton, makeMenuItemForForm, makeMenuItemForForm, makeSoftKeys, makeSoftKeys, mb, menuItemSelected, modifyForSmartPhone, onDataChangeEvent, onEvent, onSoftKey, placeCancelOnLeft, removeSoftKeyBarFor, setOKCancel, setSoftKeyBarFor, setSoftKeyBarForAll, setTitle, setTopLevelTitle, setupFrame, show, show, show, show, show, show, shown, showWait, stopFormHandle, toolsOnBottom, waitUntilClosed, waitUntilClosed, waitUntilClosed, waitUntilClosed, waitUntilPainted

Methods inherited from class ewe.ui.CellPanel

calculateSizes, makeLayoutGrid, relayout, relayoutMe, removeAll, reShow, resize, resizeTo

Methods inherited from class ewe.ui.Panel

add, addChildListener, addDirectly, addLast, addLast, addNext, addNext, addNext, doBackground, doBorder, endRow, getControlTag, getPreferredSize, getSubControls, isEmpty, layout, remove, removeChildListener, sendToChildListeners, setText

Methods inherited from class ewe.ui.Canvas

canGo, canScreenScroll, checkScrolls, doScroll, fixOrigin, getActual, getBuffer, getCurrent, getDisplayedSize, getMySize, getPercent, getScrollablePanel, getScrollClient, getVisible, getVisibleArea, needScrollBar, onScroll, onSetOrigin, reduceClip, scroll, scroll, scrollToVisible, setOrigin, updateScrollServer

Methods inherited from class ewe.ui.Container

_paintChildren, add, containerHasFocus, dismantle, doHotKey, findChild, focusFirst, focusFirst, focusOnContainer, focusOnData, getChildren, getChildrenBackwards, getNextKeyFocus, gotFocus, lostFocus, repaintDataNow, takeFocus, takePromptControl

Methods inherited from class ewe.ui.Control

acceptsData, activate, addListener, addTimer, amOnTopFrame, calculateTextSize, cancelCut, cancelHoldDown, canEdit, chainDataChange, change, checkClipboardOperations, checkExitKey, checkMenu, checkMenuKey, checkModifiers, checkPenTransparent, clearTag, clipboardToString, clipboardTransfer, closeMenu, contains, contains, createGraphics, dataAccepted, dataBeingRemoved, dataDraggedOff, dataDraggedOver, dataDraggedOver, dataDroppedOn, dataTransferCancelled, deactivate, defaultTo, doAction, doActionKey, doMenu, dontAcceptDrop, doPaint, doPaintChildren, doPaintChildren, doPaintChildren, doPaintData, doPaintData, doShowMenu, dragged, exitEntry, fillBackground, fromClipboard, fromField, fromField, getAllDescendants, getAllSubControls, getBackground, getClipboardMenu, getClipObject, getControlBuffer, getControlBuffer, getDataRect, getDataToCopy, getDataToDragAndDrop, getDim, getDragAndDropContext, getFont, getFontMetrics, getFontMetrics, getForeground, getFrame, getFrameOrContainer, getGraphics, getImage, getLastSelected, getLocation, getMaximumSize, getMenu, getMinimumSize, getModifiers, getNext, getParent, getPasswordCharacter, getPosInFrame, getPosInParent, getPreferredSize, getPrompt, getPromptText, getRect, getRect, getServer, getSize, getSizes, getTag, getText, getToolTip, getWindow, hasModifier, hasPopupFormAttached, hasTag, inheritModifiers, isChildOf, isModal, isOnMe, isSomeonesHotKey, makeFrameTopMost, makeHot, menuIsActive, modify, modifyAll, modifyAll, notifyAction, notifyDataChange, notifyDataChange, notNative_doPaintChildren, oldButWorksDoPaintChildren, oldPaintChildren, oldPostEvent, onLabelPenEvent, onPaint, onPenEvent, paintBackground, paintChildren, penClicked, penDoubleClicked, penHeld, penPressed, penReleased, penRightReleased, popupBeep, popupMenuClosed, popupMenuEvent, popupMenuEvent, postEvent, recalculatePreferredSize, redisplay, refresh, removeListener, removeTimer, repaint, repaintNow, repaintNow, repaintNow, requestPaint, requestResizeTo, resetRect, restore, scrollAndRepaint, sendToListeners, set, setBorder, setCell, setClipObject, setControl, setCursor, setFixedSize, setFont, setHotKey, setHotKey, setLocation, setMaximumSize, setMenu, setMinimumSize, setPreferredSize, setPromptControl, setRect, setRect, setServer, setTag, setTags, setTextSize, setToolTip, show, standardOnKeyEvent, startDragAndDrop, startDragAndDrop, startDragging, stopDragging, takeData, takeFromClipboard, testDim, ticked, toClipboard, toField, toField, toString, toTextData, transferPenPress, transferPenPress, tryDragAndDrop, tryNext, tryStartMenu, updateData, willAcceptDrop, willShowFrame

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode

Methods inherited from interface ewe.ui.ScrollClient

getServer, setServer

Field Detail

top

public CellPanel top

keys

public CellPanel keys

bottom

public CellPanel bottom

reset

public mButton reset

clear

public mButton clear

showClientTextFirst

public boolean showClientTextFirst

value

protected String value

isPassword

public boolean isPassword

showPrompt

public boolean showPrompt

Set this true to show a prompt at the top of the InputKeyPad. You can set this before the keypad is first displayed, but it will not have any effect after it is first displayed.

passwordCharacter

public char passwordCharacter

curText

public mLabel curText

Constructor Detail

InputKeyPad

public InputKeyPad()

Method Detail

getDisplayText

public String getDisplayText()

This gets the String to represent on screen the data String provided. If the mInput is not a password, this will just return the provided String itself. Otherwise it returns a String of "hidden" characters equal in length to the data String.

Overrides:

getDisplayText in class Control

getFormFrame

public FormFrame getFormFrame(int options)

Description copied from class: Form

This is called when the Form is about to be displayed. It creates and returns a FormFrame with the contents set to be the Form.

Overrides:

getFormFrame in class Form

doInit

protected void doInit()

Description copied from class: ControlPopupForm

This is called after the call to popup(). By default it simply calls doReset().

Overrides:

doInit in class ControlPopupForm

doReset

protected void doReset()

Description copied from class: ControlPopupForm

This should reset the Form for input. It is called by default by doInit() and by default does nothing.

Overrides:

doReset in class ControlPopupForm

doClear

protected void doClear()

Description copied from class: ControlPopupForm

By default this does nothing.

Overrides:

doClear in class ControlPopupForm

pressed

protected void pressed(Control who)

onControlEvent

public void onControlEvent(ControlEvent ev)

Description copied from class: ControlPopupForm

This listens for ControlEvent.PRESSED events from attached controls and calls setFor(Control who) if it detects that event. This will prompt the Form to display itself and take input.

Overrides:

onControlEvent in class ControlPopupForm

append

protected void append(String what)

getTextForClient

protected String getTextForClient()

Get the text to transfer back to the client. By default this returns curText.getText().

transferToClient

protected void transferToClient(Control client)

Description copied from class: ControlPopupForm

This is called if the exit value of the Form is IDOK - it is used to indicate that data should be transferred to the client control if necessary.

Overrides:

transferToClient in class ControlPopupForm

Parameters:

client - the client control for the Popup form.

close

public void close(int exitCode)

Description copied from class: Form

This closes the form unconditionally and sets the exitValue to be exitCode.

Overrides:

close in class ControlPopupForm

fixValue

protected String fixValue(String value,
                          String oldValue)

A call to setValue() will then call this method to validate the entered text. By default this just returns the value.

canExit

public boolean canExit(int exitCode)

Description copied from class: Form

This is called by the exit() method to see if the form can be closed. It should return true if it can be closed and false if it cannot.

Overrides:

canExit in class Form

canExitWithValue

protected boolean canExitWithValue(String value)

If this returns false then the InputKeyPad will not exit with a code of IDOK.

setValue

protected void setValue(String text)

refresh

public void refresh()

Re-display the text. You should probably call setValue() instead.

startingInput

protected void startingInput(Control c)

This is where the size of the input is selected (to match the number of columns in the client) and where isPassword is set.

Overrides:

startingInput in class ControlPopupForm

Parameters:

c - The new client control.

make

public void make(boolean reMake)

Description copied from class: Control

This is used to "make" the control before being displayed. This is usually only overridden by containers.

Overrides:

make in class Form