es.prodevelop.gvsig.mobile.gui.tool
Class TBButton

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byes.prodevelop.gvsig.mobile.gui.tool.GenericButton
              extended byes.prodevelop.gvsig.mobile.gui.tool.TBWidget
                  extended byes.prodevelop.gvsig.mobile.gui.tool.TBButton
All Implemented Interfaces:
java.lang.Cloneable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
TBActionButton, TBComboButton, TBSelectableButton, TBSwitcherButton

public abstract class TBButton
extends TBWidget
implements java.lang.Cloneable

Abstract class for toolbar Buttons. All types of buttons which launch a command inheritate from TBButton

Author:
mmontesinos
See Also:
TBActionButton, TBSelectableButton, TBComboButton, Serialized Form

Field Summary
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TBButton(IToolContainer _owner, java.awt.Image _icon, java.awt.Image _selectedIcon, java.lang.String _helpText, java.awt.event.MouseListener _mouseListener)
          Constructs a new instance of this class given the owner where it should be placed (which must be a ToolBar, the icons Images, the help text and the listener of the events for this new instance
TBButton(IToolContainer _owner, java.lang.String _icon, java.lang.String _selectedIcon, java.lang.String _helpText, java.awt.event.MouseListener _mouseListener)
          Constructs a new instance of this class given the owner where it should be placed (which must accomplish a IToolContainer interface, the icons, the help text and the listener of the events for this new instance
TBButton(IToolContainer _owner, java.lang.String _icon, java.lang.String _selectedIcon, java.lang.String _helpText, java.awt.event.MouseListener _mouseListener, int _index)
          Constructs a new instance of this class given the owner where it should be placed (which must accomplish a IToolContainer interface, the icons, the help text and the listener of the events for this new instance and the position of the new button in the container
TBButton(java.lang.String _icon, java.lang.String _selectedIcon, java.lang.String _helpText, java.awt.event.MouseListener _mouseListener)
          Constructs a new instance of this class not given yet the owner where it should be placed, but given the icons , the help text and the listener of the events for this new instance
 
Method Summary
 TBButton buttonClone()
          "pseudo-override" visilibity and return typeof java.lang.Object.clone() for being used when copying array of TBButtons
 boolean equals(java.lang.Object obj)
           
 int getHeight()
           
 java.lang.String getHelpText()
           
 int getStatusBarId()
           
 int getWidth()
           
 void setHeight(int height)
           
 void setStatusBarId(int statusBarId)
           
 void setWidth(int width)
           
 
Methods inherited from class es.prodevelop.gvsig.mobile.gui.tool.TBWidget
getOwner, setOwner
 
Methods inherited from class es.prodevelop.gvsig.mobile.gui.tool.GenericButton
isSelected, paint, setSelected
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, getAccessibleContext, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TBButton

public TBButton(IToolContainer _owner,
                java.lang.String _icon,
                java.lang.String _selectedIcon,
                java.lang.String _helpText,
                java.awt.event.MouseListener _mouseListener)
Constructs a new instance of this class given the owner where it should be placed (which must accomplish a IToolContainer interface, the icons, the help text and the listener of the events for this new instance

Parameters:
_owner - Parent of the TBButton (IToolContainer compliant, e.g. a ToolBar) where the button is to be added
_icon - Name of the image to be loaded as normal image
_selectedIcon - Name of the image to be loaded as selected image. Used when the button is selected
_helpText - String with a short help description of the button. it shouldn't be longer than 2 words.
_mouseListener - Listener of Mouse Events, which must be a MousListener

TBButton

public TBButton(IToolContainer _owner,
                java.lang.String _icon,
                java.lang.String _selectedIcon,
                java.lang.String _helpText,
                java.awt.event.MouseListener _mouseListener,
                int _index)
Constructs a new instance of this class given the owner where it should be placed (which must accomplish a IToolContainer interface, the icons, the help text and the listener of the events for this new instance and the position of the new button in the container

Parameters:
_owner - Parent of the TBButton (IToolContainer compliant, e.g. a ToolBar) where the button is to be added
_icon - Name of the image to be loaded as normal image
_selectedIcon - Name of the image to be loaded as selected image. Used when the button is selected
_helpText - String with a short help description of the button. it shouldn't be longer than 2 words.
_mouseListener - Listener of Mouse Events, which must be a MousListener
_index - Position of the new button in the ToolBar. It must be an int between 0 and the actual size of the array.

TBButton

public TBButton(IToolContainer _owner,
                java.awt.Image _icon,
                java.awt.Image _selectedIcon,
                java.lang.String _helpText,
                java.awt.event.MouseListener _mouseListener)
Constructs a new instance of this class given the owner where it should be placed (which must be a ToolBar, the icons Images, the help text and the listener of the events for this new instance

Parameters:
_owner - Parent of the TBButton (IToolContainer compliant, e.g. a ToolBar) where the button is to be added
_icon - Image to be loaded as normal image
_selectedIcon - Image to be loaded as selected image. Used when the button is selected
_helpText - String with a short help description of the button. it shouldn't be longer than 2 words.
_mouseListener - Listener of Mouse Events, which must be a MousListener

TBButton

public TBButton(java.lang.String _icon,
                java.lang.String _selectedIcon,
                java.lang.String _helpText,
                java.awt.event.MouseListener _mouseListener)
Constructs a new instance of this class not given yet the owner where it should be placed, but given the icons , the help text and the listener of the events for this new instance

Parameters:
_icon - Name of the image to be loaded as normal image
_selectedIcon - Name of the image to be loaded as selected image. Used when the button is selected
_helpText - String with a short help description of the button. it shouldn't be longer than 2 words.
_mouseListener - Listener of Mouse Events, which must be a MousListener
Method Detail

getHeight

public int getHeight()
Returns:
Returns the height.

setHeight

public void setHeight(int height)
Parameters:
height - The height to set in pixels.

getWidth

public int getWidth()
Returns:
Returns the width in pixels.

setWidth

public void setWidth(int width)
Parameters:
width - The width to set in pixels.

getHelpText

public java.lang.String getHelpText()
Returns:
Returns the helpText. A string with a short help description of the button. It shouldn't be longer than 2 words.

buttonClone

public TBButton buttonClone()
"pseudo-override" visilibity and return typeof java.lang.Object.clone() for being used when copying array of TBButtons

Returns:
TBButton cloned

equals

public boolean equals(java.lang.Object obj)

getStatusBarId

public int getStatusBarId()

setStatusBarId

public void setStatusBarId(int statusBarId)