eve.ui

Class Panel

java.lang.Object

eve.ui.ControlBase

eve.ui.Control

eve.ui.Container

eve.ui.Canvas

eve.ui.Panel

All Implemented Interfaces:

Drawable, ImageRefresher, DataInterface, TimerProc, CellConstants, ControlConstants, HasAncestor, IScroll, LayoutManager, ScrollClient, UIConstants, EventListener

Direct Known Subclasses:

CellPanel

public class Panel
extends Canvas
implements CellConstants, LayoutManager

A Panel is a general Container that is simpler than a CellPanel and which uses a Layout manager to layout it components. While it is not as flexible as a CellPanel and cannot support advanced features such as PanelSplitters it is faster than a CellPanel when laying out its controls.

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector	all
protected boolean	calculated
protected Vector	childListeners
int	defaultAddToMeCellConstraints The default cell constraints when controls are added to the Panel.
TagList	defaultTags This contains default Tag values for the controls added to the Panel.
boolean	equalHeights
boolean	equalWidths
protected Grid	grid
protected Control	lastAdded
LayoutManager	layoutManager This is the LayoutManager being used by the Panel.
protected boolean	made
protected static Insets	noInsets
boolean	stretchFirstColumn This is only used if the Panel is acting as its own LayoutManager - which it is by default.
boolean	stretchFirstRow This is only used if the Panel is acting as its own LayoutManager - which it is by default.
boolean	stretchLastColumn This is only used if the Panel is acting as its own LayoutManager - which it is by default.
boolean	stretchLastRow This is only used if the Panel is acting as its own LayoutManager - which it is by default.
protected int	titleGap

Fields inherited from class eve.ui.Canvas

isFullScrollClient, origin, scrollPercent, virtualSize

Fields inherited from class eve.ui.Container

closedFocus, cycleFocus, dontAutoScroll, dontFocusOnChildren, FIND_FOR_MOUSE_PRESS, takeNextFocus

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

GoHigher, GoLower, Horizontal, OPTION_INDICATOR_ONLY, PageHigher, PageLower, ScrollHigher, ScrollLower, TrackTo, Vertical

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.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
Panel() Create a new Panel which uses itself to layout components.
Panel(LayoutManager layout) Create a new Panel which uses a specific layout manager.

Method Summary

Modifier and Type	Method and Description
Control	add(Control c, int x, int y, int width, int height)
void	addChildListener(EventListener list)
void	addDirectly(Control c) Use this to add a control directly to the Panel.
Control	addLast(Control c)
Control	addLast(Control c, int cellConstraints)
Control	addLast(Control c, int cellConstraints, int controlConstraints)
Control	addNext(Control c)
Control	addNext(Control c, boolean last)
Control	addNext(Control c, int cellConstraints)
Control	addNext(Control c, int cellConstraints, int controlConstraints)
protected void	calculatedSizes() This is called after calculateSizes() has been called.
protected void	calculateSizes() Override this to calculate the preferred, minimum and maximum size of your control.
void	doBorder(Graphics g)
Control	endRow()
Object	getControlTag(int tag, Control c, Object defaultValue)
Dimension	getPreferredSize(Grid controls, Panel panel, Dimension destination)
ControlIterator	getSubControls(ControlIterator it) This returns an Iterator that goes forwards through the components which are considered a sub-control of this Control, even though they may not be a "child" of the control - i.e. it may not have been added into the Control heirarchy.
Control	insertRow(Control c, int atRow)
boolean	isEmpty()
void	layout(Grid controls, Panel panel, Rect panelRect)
void	make(boolean reMake) This is used to "make" the control before being displayed.
void	relayoutMe(boolean redisplay) This forces a recalculation of my preferred size, but not those of my children.
void	remove(Control c) Removes a child control from the container.
void	removeChildListener(EventListener list)
void	reShow(int x, int y, int toWidth, int toHeight) Resize the control and force all subcontrols to be considered to be reshown and relaid out.
void	resizeTo(int width, int height) This is called to change the width and height values.
void	sendToChildListeners(Event ev)
void	setAsBelowSip()
void	setText(String text) Calling setText() on a CellPanel gives it a labelled etched border.

Methods inherited from class eve.ui.Canvas

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

Methods inherited from class eve.ui.Container

add, completeAddPopupControl, containerHasFocus, dismantle, dismantle, doHotKey, doPaint, findChild, findChild, focusFirst, focusFirst, focusOnContainer, focusOnData, getChildren, getFirstFocus, getNextKeyFocus, gotFocus, grayOut, hide, lostFocus, relayout, removeAll, removePopupControl, repaintDataNow, setHidden, startAddPopupControl, takeFocus, takePromptControl, unhide

Methods inherited from class eve.ui.Control

acceptsData, activate, addListener, amOnTopFrame, applyFontChange, baseOnPenEvent, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, cache, calculateTextSize, calculateTextSize, calculateTextSize, cancelHoldDown, cancelPenPress, 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, deactivate, defaultTo, deferInWindowThread, doAction, doActionKey, doBackground, doMenu, dontAcceptDrop, doPaintChildren, doPaintData, doPaintData, doShowMenu, dragged, 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, 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, getPaintParameters, getParent, getParent, getParent, getParentOrListener, getPasswordCharacter, getPosInFrame, getPosInFrame, getPosInParent, getPosInParent, getPreferredSize, getPreferredSizeByParent, getPreferredTextSize, getPrompt, getPromptText, getRect, getRect, getServer, getSize, getSizes, getSubControls, getTag, getText, getToolTip, getWidth, getWindow, getWindowGraphics, hasModifier, hasPopupFormAttached, hasTag, hide, inheritModifiers, insetToContents, interceptChildUIEvent, isChildOf, isDirectChildOfWindow, isHidden, isModal, isOnMe, isOnMe, isOnMe, isSomeonesHotKey, makeFrameTopMost, makeHot, makeHot, makeInvisible, makeVisible, markAsTemporaryError, menuIsActive, menuStateChanged, modify, modifyAll, modifyAll, modifyFlags, mouseHover, newEventThread, notifyAction, notifyDataChange, notifyDataChange, notifyMenuItemSelected, notifyStructureChanged, onControlEvent, onEvent, onKeyEvent, onLabelPenEvent, onPenEvent, paintBackground, paintWithControlPainter, pauseEventThread, penClicked, penDoubleClicked, penHeld, penPressed, penReleased, penRightReleased, popupBeep, popupMenuClosed, popupMenuEvent, popupMenuEvent, postEvent, postInWindowThread, postUIEvent, putInside, queueKeyEvent, queuePenEvent, readLock, recalculatePreferredSize, redisplay, refresh, releaseBufferedGraphics, removed, removeListener, repaint, repaint, repaintInWindowThread, repaintInWindowThread, repaintNow, repaintNow, repaintNow, repaintNow, requestPaint, requestResizeTo, resetAllCachedProperties, resetCachedProperties, resetRect, 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, startDragging, stopDragging, takeData, takeFromClipboard, 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

Methods inherited from interface eve.ui.ScrollClient

getServer, setServer

Field Detail

noInsets

protected static Insets noInsets

defaultTags

public TagList defaultTags

This contains default Tag values for the controls added to the Panel. The only Tag used by Panel is the INSETS tag, which must contain an ewe.fx.Insets object value.

defaultAddToMeCellConstraints

public int defaultAddToMeCellConstraints

The default cell constraints when controls are added to the Panel. The default value is STRETCH

grid

protected Grid grid

stretchFirstColumn

public boolean stretchFirstColumn

This is only used if the Panel is acting as its own LayoutManager - which it is by default. It tells it to stretch the first column to fill the width of the Panel - it is false by default. If it is set true it will override stretchLastColumn.

stretchFirstRow

public boolean stretchFirstRow

This is only used if the Panel is acting as its own LayoutManager - which it is by default. It tells it to stretch the first row to fill the height of the Panel - it is false by default. If it is set true it will override stretchLastRow.

stretchLastColumn

public boolean stretchLastColumn

This is only used if the Panel is acting as its own LayoutManager - which it is by default. It tells it to stretch the last column to fill the width of the Panel - it is true by default.

stretchLastRow

public boolean stretchLastRow

This is only used if the Panel is acting as its own LayoutManager - which it is by default. It tells it to stretch the last row to fill the height of the Panel - it is true by default.

equalWidths

public boolean equalWidths

equalHeights

public boolean equalHeights

layoutManager

public LayoutManager layoutManager

This is the LayoutManager being used by the Panel. By default it will be the Panel itself. You can set this via a direct assignment.

childListeners

protected Vector childListeners

all

protected Vector all

lastAdded

protected Control lastAdded

made

protected boolean made

calculated

protected boolean calculated

titleGap

protected int titleGap

Constructor Detail

Panel

public Panel()

Create a new Panel which uses itself to layout components.

Panel

public Panel(LayoutManager layout)

Create a new Panel which uses a specific layout manager.

Method Detail

isEmpty

public boolean isEmpty()

getControlTag

public Object getControlTag(int tag,
                            Control c,
                            Object defaultValue)

add

public Control add(Control c,
                   int x,
                   int y,
                   int width,
                   int height)

insertRow

public Control insertRow(Control c,
                         int atRow)

addNext

public Control addNext(Control c,
                       boolean last)

addLast

public Control addLast(Control c)

addNext

public Control addNext(Control c)

endRow

public Control endRow()

addNext

public Control addNext(Control c,
                       int cellConstraints,
                       int controlConstraints)

addLast

public Control addLast(Control c,
                       int cellConstraints,
                       int controlConstraints)

addNext

public Control addNext(Control c,
                       int cellConstraints)

addLast

public Control addLast(Control c,
                       int cellConstraints)

setText

public void setText(String text)

Calling setText() on a CellPanel gives it a labelled etched border.

Overrides:

setText in class Control

addChildListener

public void addChildListener(EventListener list)

removeChildListener

public void removeChildListener(EventListener list)

sendToChildListeners

public void sendToChildListeners(Event ev)

make

public void make(boolean reMake)

Description copied from class: Container

This is used to "make" the control before being displayed.

Overrides:

make in class Container

Parameters:

reMake - if this is true then you should do a full re-make.

setAsBelowSip

public void setAsBelowSip()

layout

public void layout(Grid controls,
                   Panel panel,
                   Rect panelRect)

Specified by:

layout in interface LayoutManager

getPreferredSize

public Dimension getPreferredSize(Grid controls,
                                  Panel panel,
                                  Dimension destination)

Specified by:

getPreferredSize in interface LayoutManager

addDirectly

public void addDirectly(Control c)

Use this to add a control directly to the Panel. It makes it a child control immediately.

Overrides:

addDirectly in class Container

remove

public void remove(Control c)

Description copied from class: Container

Removes a child control from the container. Normally you would not use this but use a higher function provided by an inherited Control.

Overrides:

remove in class Container

getSubControls

public ControlIterator getSubControls(ControlIterator it)

Description copied from class: Control

This returns an Iterator that goes forwards through the components which are considered a sub-control of this Control, even though they may not be a "child" of the control - i.e. it may not have been added into the Control heirarchy.

Overrides:

getSubControls 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

calculatedSizes

protected void calculatedSizes()

Description copied from class: Control

This is called after calculateSizes() has been called.

Overrides:

calculatedSizes in class Control

resizeTo

public void resizeTo(int width,
                     int height)

Description copied from class: Control

This is called to change the width and height values. It is always called when the Control gets resized so you can override it to react to a resizing of a Control.

Overrides:

resizeTo in class Control

doBorder

public void doBorder(Graphics g)

Overrides:

doBorder in class Canvas

reShow

public void reShow(int x,
                   int y,
                   int toWidth,
                   int toHeight)

Description copied from class: Container

Resize the control and force all subcontrols to be considered to be reshown and relaid out.

Overrides:

reShow in class Container

Parameters:

x - the new or same x location.

y - the new or same y location.

toWidth - the new or same width.

toHeight - the new or same height.

relayoutMe

public void relayoutMe(boolean redisplay)

This forces a recalculation of my preferred size, but not those of my children.