ewe.ui
Class Frame

java.lang.Object
  ewe.ui.ControlBase
      ewe.ui.Control
          ewe.ui.Container
              ewe.ui.Canvas
                  ewe.ui.Panel
                      ewe.ui.CellPanel
                          ewe.ui.Frame

All Implemented Interfaces:

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

Direct Known Subclasses:

AppFrame, CarrierFrame, FormFrame

public class Frame

extends CellPanel

Field Summary

CellPanel	bottom
boolean	capturePressedOutside
boolean	closeWindow
CellPanel	contents
boolean	contentsOnly
Vector	controlsToRefresh This is a collection of components that should be refreshed when the frame is removed.
int	displayOptions This is set to either Gui.FILL_FRAME or Gui.CENTER_FRAME depending on the option chosen when it was shown/exec'ed
boolean	doSaveScreen
boolean	isControlPanel
PopupController	popupController
static int	PressedOutside
boolean	resizeOnSIP
SavedScreen	savedScreen
CellPanel	top
protected CellPanel	trueBottom
boolean	wantPressedOutside

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

Frame()

Method Summary

void	eraseSavedScreen()
void	exec(Container parent, int options) This will add the frame to the container and call a make() on it.
void	hide() This closes the frame.
boolean	isPopup()
void	make(boolean reMake) This is used to "make" the control before being displayed.
void	onEvent(Event ev)
void	pressedOutside(Point whereOnScreen)
void	relayoutAndResize(boolean overrideMaximize) This does a relayout of the Frame and its children and then resizes the Frame to fit the new layout.
void	resize(boolean overrideMaximize) This resizes a Frame and its contents to be its preferred size.
void	resize(int width, int height, boolean overrideMaximize) This resizes a Frame and its contents.
void	setRect(int x, int y, int w, int h)
void	setRect(int x, int y, int w, int h, Control relativeTo)
void	show(Container parent, int options) This will add the frame to the container and call a make() on it.

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, dismantle, doHotKey, findChild, focusFirst, focusFirst, focusOnContainer, focusOnData, getChildren, getChildrenBackwards, getFirstFocus, 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, formClosing, fromClipboard, fromField, fromField, getAllDescendants, getAllSubControls, getBackground, getClipboardMenu, getClipObject, getControlBuffer, getControlBuffer, getDataRect, getDataToCopy, getDataToDragAndDrop, getDim, getDisplayText, 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, onControlEvent, onKeyEvent, 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, setServer, setTag, setTags, setTextSize, setToolTip, show, shown, 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

PressedOutside

public static final int PressedOutside

See Also:

Constant Field Values

wantPressedOutside

public boolean wantPressedOutside

contentsOnly

public boolean contentsOnly

capturePressedOutside

public boolean capturePressedOutside

doSaveScreen

public boolean doSaveScreen

resizeOnSIP

public boolean resizeOnSIP

isControlPanel

public boolean isControlPanel

popupController

public PopupController popupController

closeWindow

public boolean closeWindow

top

public CellPanel top

bottom

public CellPanel bottom

contents

public CellPanel contents

savedScreen

public SavedScreen savedScreen

controlsToRefresh

public Vector controlsToRefresh

This is a collection of components that should be refreshed when the frame is removed. It is initially null until something is added.

displayOptions

public int displayOptions

This is set to either Gui.FILL_FRAME or Gui.CENTER_FRAME depending on the option chosen when it was shown/exec'ed

trueBottom

protected CellPanel trueBottom

Constructor Detail

Frame

public Frame()

Method Detail

resize

public void resize(int width,
                   int height,
                   boolean overrideMaximize)

This resizes a Frame and its contents. It works if a Frame is in its own Window OR if it the child of another Frame.

Parameters:

width - The new width for the Frame.

height - The new height for the Frame.

overrideMaximize - If this is true then a resize is forced regardless of the possible maximized state of the window. If it is false, then if the window containing the Frame is maximized, no resize will be done.

resize

public void resize(boolean overrideMaximize)

This resizes a Frame and its contents to be its preferred size. It works if a Frame is in its own Window OR if it the child of another Frame.

Parameters:

overrideMaximize - If this is true then a resize is forced regardless of the possible maximized state of the window. If it is false, then if the window containing the Frame is maximized, no resize will be done.

relayoutAndResize

public void relayoutAndResize(boolean overrideMaximize)

This does a relayout of the Frame and its children and then resizes the Frame to fit the new layout.

Parameters:

overrideMaximize - If this is true then a resize is forced regardless of the possible maximized state of the window. If it is false, then if the window containing the Frame is maximized, no resize will be done.

isPopup

public boolean isPopup()

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 CellPanel

pressedOutside

public void pressedOutside(Point whereOnScreen)

setRect

public void setRect(int x,
                    int y,
                    int w,
                    int h,
                    Control relativeTo)

setRect

public void setRect(int x,
                    int y,
                    int w,
                    int h)

Overrides:

setRect in class Control

eraseSavedScreen

public void eraseSavedScreen()

exec

public void exec(Container parent,
                 int options)

This will add the frame to the container and call a make() on it. This also sets the frame to be modal. If you specify an option of Gui.FILL_FRAME or Gui.CENTER_FRAME then the frame will be positioned and displayed on screen. If not you will have to call setRect()/repaintNow() on the frame to cause it to be positioned and painted.

show

public void show(Container parent,
                 int options)

This will add the frame to the container and call a make() on it. This also sets the frame to be non-modal. If you specify an option of Gui.FILL_FRAME or Gui.CENTER_FRAME then the frame will be positioned and displayed on screen. If not you will have to call setRect()/repaintNow() on the frame to cause it to be positioned and painted.

hide

public void hide()

This closes the frame.

onEvent

public void onEvent(Event ev)

Specified by:

onEvent in interface EventListener

Overrides:

onEvent in class CellPanel