mhframework.gui
Class MHGUIButtonMenu

java.lang.Object
  extended by mhframework.gui.MHGUIComponent
      extended by mhframework.gui.MHGUIButtonMenu
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.MouseListener, java.util.EventListener, MHRenderable

public class MHGUIButtonMenu
extends MHGUIComponent

Class for making a menu of buttons.


Field Summary
 
Fields inherited from class mhframework.gui.MHGUIComponent
focusable, height, state, width
 
Constructor Summary
MHGUIButtonMenu()
          Constructor.
 
Method Summary
 void add(int index, MHGUIComponent component)
          Adds a button or other component to the menu.
 void add(MHGUIComponent component)
          Adds a button or other component to the menu.
 void advance()
          Tells an object to update its data.
 MHGUIComponentList getButtons()
          Returns the buttons.
 void keyPressed(java.awt.event.KeyEvent e)
           
 void keyReleased(java.awt.event.KeyEvent e)
           
 void keyTyped(java.awt.event.KeyEvent e)
           
 void mouseClicked(java.awt.event.MouseEvent e)
           
 void mouseMoved(java.awt.event.MouseEvent e)
           
 void mousePressed(java.awt.event.MouseEvent e)
           
 void mouseReleased(java.awt.event.MouseEvent e)
           
 void render(java.awt.Graphics2D g)
          Tells an object to draw itself onto the sent Graphics object.
 void setBackgroundColor(java.awt.Color bgColor)
          Sets the color for the menu's background.
 void setBorderSpacing(int b)
          Sets the distance in pixels between the edge of the menu and the buttons on the menu.
 void setButtonSize(int width, int height)
          Sets the width and height of every button on the menu.
 void setText(java.lang.String text)
          Sets the caption text for the menu.
 void setTextColor(java.awt.Color c)
          Sets the text color for the menu's caption.
 void setVerticalSpacing(int v)
          Sets the distance in pixels between each button on the menu.
 
Methods inherited from class mhframework.gui.MHGUIComponent
actionPerformed, getBounds, getHeight, getWidth, getX, getY, hasFocus, isEnabled, isVisible, mouseDragged, mouseEntered, mouseExited, paint, setEnabled, setFocus, setFocusable, setHeight, setPosition, setSize, setVisible, setWidth, setX, setY, updateBounds
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MHGUIButtonMenu

public MHGUIButtonMenu()
Constructor.

Method Detail

setBackgroundColor

public void setBackgroundColor(java.awt.Color bgColor)
Sets the color for the menu's background.

Parameters:
bgColor - The color to use as the menu's background color.

setButtonSize

public void setButtonSize(int width,
                          int height)
Sets the width and height of every button on the menu.

Parameters:
width - The width of the buttons.
height - The height of the buttons.

setVerticalSpacing

public void setVerticalSpacing(int v)
Sets the distance in pixels between each button on the menu.

Parameters:
v - The vertical distance in pixels between the buttons.

setBorderSpacing

public void setBorderSpacing(int b)
Sets the distance in pixels between the edge of the menu and the buttons on the menu.

Parameters:
b - The distance in pixels between the menu's edge and the buttons.

setText

public void setText(java.lang.String text)
Sets the caption text for the menu.

Parameters:
text - The string to use as the menu caption.

setTextColor

public void setTextColor(java.awt.Color c)
Sets the text color for the menu's caption.

Parameters:
c - The color to use for the menu caption.

add

public void add(MHGUIComponent component)
Adds a button or other component to the menu.

Parameters:
component - The button or component being added to the menu.

add

public void add(int index,
                MHGUIComponent component)
Adds a button or other component to the menu.

Parameters:
component - The button or component being added to the menu.

advance

public void advance()
Description copied from interface: MHRenderable
Tells an object to update its data.


render

public void render(java.awt.Graphics2D g)
Description copied from interface: MHRenderable
Tells an object to draw itself onto the sent Graphics object.

Parameters:
g - The Graphics object on which this object is to draw itself.

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)
Specified by:
keyTyped in class MHGUIComponent

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)
Specified by:
keyReleased in class MHGUIComponent

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)
Specified by:
keyPressed in class MHGUIComponent

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)
Specified by:
mouseMoved in class MHGUIComponent

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)
Specified by:
mousePressed in interface java.awt.event.MouseListener
Specified by:
mousePressed in class MHGUIComponent

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
Specified by:
mouseReleased in interface java.awt.event.MouseListener
Specified by:
mouseReleased in class MHGUIComponent

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
Specified by:
mouseClicked in interface java.awt.event.MouseListener
Specified by:
mouseClicked in class MHGUIComponent

getButtons

public MHGUIComponentList getButtons()
Returns the buttons.

Returns:
MHGUIComponentList