org.xith3d.ui.swingui
Class UIPositionedWindow

java.lang.Object
  org.xith3d.scenegraph.SceneGraphObject
      org.xith3d.scenegraph.Node
          org.xith3d.scenegraph.GroupNode
              org.xith3d.scenegraph.Group
                  org.xith3d.ui.swingui.UIPositionedWindow

All Implemented Interfaces:

org.jagatoo.datatypes.NamableObject, org.jagatoo.datatypes.NamedObject, org.openmali.spatial.SpatialNode

public class UIPositionedWindow
extends Group

Insert package comments here

Originally Coded by David Yazel on Oct 4, 2003 at 10:51:03 PM.

Field Summary

Fields inherited from class org.xith3d.scenegraph.GroupNode

children, hostGroup, numChildren, totalNumChildren, totalNumShapes

Fields inherited from class org.xith3d.scenegraph.Node

boundsAutoCompute, boundsDirty, globalIgnoreBounds, instanceBoundsTypeHint, parent, transformGroup, untransformedBounds

Fields inherited from class org.xith3d.scenegraph.SceneGraphObject

XITH3D_USERDATAKEY_OLDUSERDATA

Constructor Summary

UIPositionedWindow()

Method Summary

void	assign(UIOverlayInterface overlay) This attaches an overlay to this window.
boolean	contains(java.awt.Point p)
void	empty() Used to free the overlay from the overlay window.
UIOverlayInterface	getOverlay()
java.awt.Rectangle	getRectangle() Get the bounds
int	getX()
int	getY()
boolean	isAssigned()
boolean	isDraggable()
boolean	isVisible()
void	setDraggable(boolean b)
void	setPosition(int x, int y, java.awt.Dimension canvasDim) Sets the position of the window using the position transformation
void	setVisible(boolean show) Sets the overlay visible if the specified value is true

Methods inherited from class org.xith3d.scenegraph.Group

moveTo, newInstance, traverse

Methods inherited from class org.xith3d.scenegraph.GroupNode

absorbDetails, addChild, addChild, checkChild, dump, dump, ensureCapacity, expandBounds, findAll, findAll, findFirst, findFirst, freeOpenGLResources, getChild, getChildren, getChildren, getClipper, getPickHost, getScissorRect, getTotalNumChildren, getTotalNumShapes, indexOf, isPickHost, mergeInheritedClipper, mergeInheritedNodes, mergeInheritedScissorRect, numChildren, removeAllChildren, removeChild, removeChild, setBoundsDirty, setBoundsDirtyUpward, setChild, setClipper, setPickHost, setPickHost, setScissorRect, setShowBounds, sharedCopy, sharedCopy, traverse, unmergeInheritedFog, unmergeInheritedLight, unmergeInheritedNodes, updateBounds, updateBoundsCheap

Methods inherited from class org.xith3d.scenegraph.Node

cloneNode, detach, duplicateNode, freeOpenGLResources, getBounds, getBoundsAutoCompute, getBoundsType, getBoundsTypeHint, getDefaultPickable, getIndentString, getInheritedNodeAttributes, getModListener, getOrderedChild, getOrderedState, getParent, getRoot, getShadowAttachment, getShowBounds, getTransformGroup, getTreeCell, getWorldBounds, getWorldTransform, getWorldTransform, isBillboard, isIgnoreBounds, isOccluder, isPickable, isRenderable, isUpdatableNode, popGlobalIgnoreBounds, printBounds, pushGlobalIgnoreBounds, setBounds, setBoundsAutoCompute, setBoundsTypeHint, setDefaultPickable, setGlobalIgnoreBounds, setIgnoreBounds, setIsOccluder, setModListener, setOrderedChild, setParent, setPickable, setPickableRecursive, setPickableRecursive, setRenderable, setShadowAttachment, setShowBounds, setTransformGroup, setTreeCell, updateOrderedChild, updateTransformGroup, updateWorldTransform

Methods inherited from class org.xith3d.scenegraph.SceneGraphObject

getName, getUserData, getUserData, getUserDataMap, isLive, setLive, setName, setUserData, setUserData, setUserDataRecursive, setUserDataRecursive, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UIPositionedWindow

public UIPositionedWindow()

Method Detail

getRectangle

public java.awt.Rectangle getRectangle()

Get the bounds

contains

public boolean contains(java.awt.Point p)

Returns:

true if the point passed in is contained within the bounds of the window.

setPosition

public void setPosition(int x,
                        int y,
                        java.awt.Dimension canvasDim)

Sets the position of the window using the position transformation

setDraggable

public void setDraggable(boolean b)

isDraggable

public boolean isDraggable()

getX

public int getX()

getY

public int getY()

empty

public void empty()

Used to free the overlay from the overlay window.

isAssigned

public boolean isAssigned()

Returns:

true of the ovwelay window is assigned to an overlay

assign

public void assign(UIOverlayInterface overlay)

This attaches an overlay to this window. If there is already one assigned then it will be released.

isVisible

public boolean isVisible()

Returns:

true if the overlay is visible

getOverlay

public UIOverlayInterface getOverlay()

Returns:

the assigned overlay

setVisible

public void setVisible(boolean show)

Sets the overlay visible if the specified value is true