eve.ui.game

Class Mosaic

java.lang.Object

eve.ui.ControlBase

eve.ui.Control

eve.ui.Container

eve.ui.Canvas

eve.ui.game.Mosaic

All Implemented Interfaces:

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

Direct Known Subclasses:

MosaicPanel

public class Mosaic
extends Canvas
implements ImageRefresher

A Mosaic is used to display multiple images, each of which may be able to move and or be animated. The Mosaic ensures that, should an image need to be refreshed due to being moved or changed, that an effecient screen refresh will be done.

Mosaic is also the base object for a MosaicPanel - which provides convenience methods to detect when the user presses/drags the pen/mouse on an image in the Mosaic.

MosaicPanel is also the base object for an InteractivePanel - which provides methods to move images when the user drags them with the pen/mouse and also to detect when one image is being dragged over another.

NOTE - as of this release the QuickDragging has been temporarily disabled.

Field Summary

Fields

Modifier and Type	Field and Description
IImage	backgroundImage Set this to be a backgroundImage.
protected boolean	firstSnap
ImageList	images These are the images in the Mosaic.
protected boolean	pauseSnapShots
boolean	quickDragging Set this true IF, while one image is being dragged no other images will change.

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

KEEP_VISIBLE

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

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
Mosaic()

Method Summary

Modifier and Type	Method and Description
void	addImage(AniImage im) Add an image to the mosaic.
void	addToSnapShot(AniImage which) This is used for advanced refreshing with quickDragging.
Image	confirmImage(Image what)
void	doPaint(Graphics g, Rect area) The doPaint() method for the Control.
void	dropImage(AniImage which) This is used with quickDragging.
void	onSetOrigin()
void	paintMosaicBackground(Graphics g)
void	paintMosaicBackground(Graphics g, Rect area) Paint the mosaic background, with the Graphics already translated by -origin.x, -origin.y
void	refresh() Repaint the entire mosaic.
void	refresh(AniImage image, Graphics gr) Refresh a particular image.
void	refresh(Graphics gr) Paint the entire mosaic to the graphics.
void	refresh(IImage image, int options) The default version of this method simpy repaints the control - however for controls which may display multiple images a better refresh scheme would be needed.
void	refresh(Rect area, Graphics gr) Refresh the mosaic.
void	refresh(Rect area, Graphics gr, boolean doingOneImage) Refresh an area on the mosaic.
void	refreshChanged(Graphics gr) This refreshes all images marked as changed.
boolean	refreshOnScreen(AniImage movedImage) This method is used to refresh an Image that has been moved, but that you want to make sure remains fully visible, by scrolling the Mosaic if necessary.
void	removeFromSnapShot(AniImage which) This is used for advanced refreshing with quickDragging.
void	removeImage(AniImage im) Remove an image from the mosaic.
void	setAndSizeToBackgroundImage(Image img) This sets the backgroundImage AND sets the virtualSize to be the same size as the image.
void	setMovingImage(AniImage which) This is used with quickDragging.
void	takeSnapShot() This is used for advanced refreshing with quickDragging.

Methods inherited from class eve.ui.Canvas

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

Methods inherited from class eve.ui.Container

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

Methods inherited from class eve.ui.Control

acceptsData, activate, addListener, amOnTopFrame, applyFontChange, baseOnPenEvent, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, cache, calculatedSizes, calculateSizes, 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, 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, releaseBufferedGraphics, removed, removeListener, repaint, repaint, 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, 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

quickDragging

public boolean quickDragging

Set this true IF, while one image is being dragged no other images will change. It makes the updating of moving images somewhat more effecient.

images

public ImageList images

These are the images in the Mosaic. However don't add/remove from it directly. Use the addImage()/removeImage() methods instead.

backgroundImage

public IImage backgroundImage

Set this to be a backgroundImage.

pauseSnapShots

protected boolean pauseSnapShots

firstSnap

protected boolean firstSnap

Constructor Detail

Mosaic

public Mosaic()

Method Detail

setAndSizeToBackgroundImage

public void setAndSizeToBackgroundImage(Image img)

This sets the backgroundImage AND sets the virtualSize to be the same size as the image. It does NOT set the preferredSize of the mosaic. You still have to set that yourself.

addImage

public void addImage(AniImage im)

Add an image to the mosaic.

removeImage

public void removeImage(AniImage im)

Remove an image from the mosaic.

paintMosaicBackground

public void paintMosaicBackground(Graphics g,
                                  Rect area)

Paint the mosaic background, with the Graphics already translated by -origin.x, -origin.y

Parameters:

g - the graphics for drawing.

area - the area on the virtual mosaic surface (not the area on the Control) that needs drawing. If this is null you must paint the entire control.

paintMosaicBackground

public void paintMosaicBackground(Graphics g)

confirmImage

public Image confirmImage(Image what)

takeSnapShot

public void takeSnapShot()

This is used for advanced refreshing with quickDragging.

removeFromSnapShot

public void removeFromSnapShot(AniImage which)

This is used for advanced refreshing with quickDragging.

addToSnapShot

public void addToSnapShot(AniImage which)

This is used for advanced refreshing with quickDragging.

setMovingImage

public void setMovingImage(AniImage which)

This is used with quickDragging. Call this method to set the image that is moving.

dropImage

public void dropImage(AniImage which)

This is used with quickDragging. This tells the mosaic that the previously moving image is no longer moving.

refresh

public void refresh(Rect area,
                    Graphics gr)

Refresh the mosaic. If gr is null then a Graphics will be created. if area is null then the entire mosaic will be refreshed. Normally you will not call this method. Instead you will generally refresh just a single image.

Parameters:

area - the area on the virtual mosaic surface, not the area on the Control.

gr - a Graphics to draw on, which has been

refresh

public void refresh(Rect area,
                    Graphics gr,
                    boolean doingOneImage)

Refresh an area on the mosaic. If gr is null then a Graphics will be created. if area is null then the entire mosaic will be refreshed. Normally you will not call this method. Instead you will generally refresh just a single image.

Parameters:

area - the area on the virtual mosaic surface, not the area on the Control.

gr - a Graphics to draw on, which has been

doingOneImage -

refreshChanged

public void refreshChanged(Graphics gr)

This refreshes all images marked as changed. If gr is null, then a new graphics will be created and used.

refresh

public void refresh(AniImage image,
                    Graphics gr)

Refresh a particular image. If gr is null then a new Graphics will be created and used.

refresh

public void refresh(Graphics gr)

Paint the entire mosaic to the graphics. If gr is null then a new Graphics will be created and used.

refresh

public void refresh()

Repaint the entire mosaic.

doPaint

public void doPaint(Graphics g,
                    Rect area)

The doPaint() method for the Control.

Overrides:

doPaint in class Container

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.

onSetOrigin

public void onSetOrigin()

Overrides:

onSetOrigin in class Canvas

refreshOnScreen

public boolean refreshOnScreen(AniImage movedImage)

This method is used to refresh an Image that has been moved, but that you want to make sure remains fully visible, by scrolling the Mosaic if necessary. Note that this will only work correctly IF the virtualSize value has been set AND the image remains in the range (0,0) to (virtualSize.x-imageWidth,virtualSize.y-imageHeight).

This method will also update the scroll bars if there are any.

Parameters:

movedImage - The image that has been moved or changed in some way.

Returns:

true if a scroll was done, false if no scrolling occured.

refresh

public void refresh(IImage image,
                    int options)

Description copied from class: Control

The default version of this method simpy repaints the control - however for controls which may display multiple images a better refresh scheme would be needed.

Specified by:

refresh in interface ImageRefresher

Overrides:

refresh in class Control

Parameters:

image - the image to refresh.

options - refresh options.