org.deken.game.component
Class GDecoratedContainer

java.lang.Object
  extended by org.deken.game.sprites.Sprite
      extended by org.deken.game.component.GComponent
          extended by org.deken.game.component.GContainer
              extended by org.deken.game.component.GDecoratedContainer
All Implemented Interfaces:
InputMouseListener, Updateable

public class GDecoratedContainer
extends GContainer

Title: GDecoratedContainer

Description: This is a wrapper of the GContainer, applying a decoration (images) around the contents.

Copyright: Copyright (c) 2006

Version:
1.0
Author:
Gary Deken

Nested Class Summary
 
Nested classes/interfaces inherited from class org.deken.game.component.GComponent
GComponent.Alignment, GComponent.MouseActions
 
Field Summary
 
Fields inherited from class org.deken.game.component.GContainer
backgroundColor, grabbed
 
Fields inherited from class org.deken.game.component.GComponent
horizontalAlignment, id, invalid, keyPolling, mouseActions, parent, requestKeyPolling, screenHeight, screenWidth, verticalAlignment, xOffSet, yOffSet
 
Fields inherited from class org.deken.game.sprites.Sprite
boundingBox, collisionMap, location, size
 
Constructor Summary
GDecoratedContainer(int screenWidth, int screenHeight, GContainer gameContainer)
           
GDecoratedContainer(int screenWidth, int screenHeight, InputMonitor.Mouse mouseAction, GContainer gameContainer)
           
 
Method Summary
 void add(GComponent component)
          Adds the component to this container if it extends GContainer.
 GComponent copy()
           
 void draw(java.awt.Graphics2D graphics, int xOffset, int yOffset)
          Draws the sprite with the current offset.
 java.util.List getChildren()
           
 GComponent getComponentByName(java.lang.String name)
           
 void notifyListener(InputMouseAction inputMouseAction)
          notifyListener
 void remove(GComponent gameComponent)
           
 void setMonitored(boolean active)
           
protected  void spriteCollison(Sprite collideSprite)
          Handle the collision with another sprite.
 void update(long elapseTime)
          update
 void validate(java.awt.Graphics2D graphics)
           
 
Methods inherited from class org.deken.game.component.GContainer
copyBase, isGrabbed, isSizeSet, setBackgroundColor, setGrabbed, setScreenHeightWidth
 
Methods inherited from class org.deken.game.component.GComponent
addMouseAction, copyBase, getHorizontalAlignment, getMouseActions, getParent, getVerticalAlignment, getXLocation, getYLocation, isEnabled, positionHorizontalAlignment, positionVerticalAlignment, requestKeyPolling, setEnabled, setHorizontalAlignment, setInvalid, setKeyPolling, setParent, setVerticalAlignment
 
Methods inherited from class org.deken.game.sprites.Sprite
getBounds, getDepth, getHeight, getLocation, getName, getSize, getWidth, removeFromMap, setBoundingBox, setBoundingBox, setCollisionMap, setLocation, setName, setSize, toString, updateLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GDecoratedContainer

public GDecoratedContainer(int screenWidth,
                           int screenHeight,
                           GContainer gameContainer)

GDecoratedContainer

public GDecoratedContainer(int screenWidth,
                           int screenHeight,
                           InputMonitor.Mouse mouseAction,
                           GContainer gameContainer)
Method Detail

add

public void add(GComponent component)
Adds the component to this container if it extends GContainer. Otherwise it will throw a FactoryException.

Specified by:
add in class GContainer
Parameters:
component -
Throws:
FactoryException

copy

public GComponent copy()
Specified by:
copy in class GComponent
Returns:
GComponent

draw

public void draw(java.awt.Graphics2D graphics,
                 int xOffset,
                 int yOffset)
Description copied from class: GComponent
Draws the sprite with the current offset.

Specified by:
draw in class GComponent

getChildren

public java.util.List getChildren()
Specified by:
getChildren in class GContainer
Returns:
List of GComponents that this GContainer holds.

getComponentByName

public GComponent getComponentByName(java.lang.String name)
Specified by:
getComponentByName in class GContainer
Returns:
GComponent

notifyListener

public void notifyListener(InputMouseAction inputMouseAction)
Description copied from interface: InputMouseListener
notifyListener

This method is called when any Mouse Motion event occurs.

Parameters:
inputMouseAction - InputMouseAction

remove

public void remove(GComponent gameComponent)
Specified by:
remove in class GContainer

setMonitored

public void setMonitored(boolean active)
Specified by:
setMonitored in class GComponent

update

public void update(long elapseTime)
Description copied from class: GComponent
update

This method takes the elapse time, and calculates the new current frame of the animation.

Specified by:
update in interface Updateable
Specified by:
update in class GComponent
Parameters:
elapseTime - long

validate

public void validate(java.awt.Graphics2D graphics)
Specified by:
validate in class GComponent

spriteCollison

protected void spriteCollison(Sprite collideSprite)
Description copied from class: Sprite
Handle the collision with another sprite.

Specified by:
spriteCollison in class Sprite