javax.swing.plaf.basic
Class BasicArrowButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      javax.swing.plaf.basic.BasicArrowButton

All Implemented Interfaces:

ImageObserver , ItemSelectable , MenuContainer , Serializable , Accessible , SwingConstants

Direct Known Subclasses:

MetalScrollButton

public class BasicArrowButton
extends JButton
implements SwingConstants

JButton object that draws a scaled Arrow in one of the cardinal directions.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans ^TM has been added to the java.beans package. Please see XMLEncoder .

Field Summary
protected  int	direction           The direction of the arrow.

Constructor Summary
BasicArrowButton (int direction)           Creates a BasicArrowButton whose arrow is drawn in the specified direction.
BasicArrowButton (int direction, Color  background, Color  shadow, Color  darkShadow, Color           Creates a BasicArrowButton whose arrow is drawn in the specified direction and with the specified colors.

Method Summary
int	getDirection ()           Returns the direction of the arrow.
Dimension	getMaximumSize ()           Returns           If the maximum size of the BasicArrowButton. has been set to a non-null value just returns it.
Dimension	getMinimumSize ()           Returns           If the minimum size of the BasicArrowButton. has been set to a non-null value just returns it.
Dimension	getPreferredSize ()           Returns           If the preferred size of the BasicArrowButton. preferredSize has been set to a non-null value just returns it.
boolean	isFocusTraversable ()           Returns whether this Component can become the arrow button should get the focus. focus owner.
void	paint ( Graphics  g)           Invoked by Swing to draw components.
void	paintTriangle ( Graphics           Paints a triangle.
void	setDirection (int dir)           Sets the direction of the arrow.

Methods inherited from class javax.swing. AbstractButton

actionPropertyChanged , addActionListener , addChangeListener , addImpl , addItemListener , checkHorizontalKey , checkVerticalKey , configurePropertiesFromAction , createActionListener , createActionPropertyChangeListener , createChangeListener , createItemListener , doClick , doClick , fireActionPerformed , fireItemStateChanged , fireStateChanged , getAction , getActionCommand , getActionListeners , getChangeListeners , getDisabledIcon , getDisabledSelectedIcon , getDisplayedMnemonicIndex , getHideActionText , getHorizontalAlignment , getHorizontalTextPosition , getIcon , getIconTextGap , getItemListeners , getLabel , getMargin , getMnemonic , getModel , getMultiClickThreshhold , getPressedIcon , getRolloverIcon , getRolloverSelectedIcon , getSelectedIcon , getSelectedObjects , getText , getUI , getVerticalAlignment , getVerticalTextPosition , imageUpdate , init , isBorderPainted , isContentAreaFilled , isFocusPainted , isRolloverEnabled , isSelected , paintBorder , removeActionListener , removeChangeListener , removeItemListener , setAction , setActionCommand , setBorderPainted , setContentAreaFilled , setDisabledIcon , setDisabledSelectedIcon , setDisplayedMnemonicIndex , setEnabled , setFocusPainted , setHideActionText , setHorizontalAlignment , setHorizontalTextPosition , setIcon , setIconTextGap , setLabel , setLayout , setMargin , setMnemonic , setMnemonic , setModel , setMultiClickThreshhold , setPressedIcon , setRolloverEnabled , setRolloverIcon , setRolloverSelectedIcon , setSelected , setSelectedIcon , setText , setUI , setVerticalAlignment , setVerticalTextPosition

direction

protected int direction

The direction of the arrow. One of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.EAST or SwingConstants.WEST.

BasicArrowButton

public BasicArrowButton(int direction,
                        Color background,
                        Color shadow,
                        Color darkShadow,
                        Color highlight)

Creates a BasicArrowButton whose arrow is drawn in the specified direction and with the specified colors.

Parameters:

direction - the direction of the arrow; one of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.EAST or SwingConstants.WEST

background - the background color of the button

shadow - the color of the shadow

darkShadow - the color of the dark shadow

highlight - the color of the highlight

Since:

1.4

BasicArrowButton

public BasicArrowButton(int direction)

Creates a BasicArrowButton whose arrow is drawn in the specified direction.

Parameters:

direction - the direction of the arrow; one of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.EAST or SwingConstants.WEST

getDirection

public int getDirection()

Returns the direction of the arrow.

Parameters:

direction - the direction of the arrow; one of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.EAST or SwingConstants.WEST

setDirection

public void setDirection(int dir)

Sets the direction of the arrow.

Parameters:

direction - the direction of the arrow; one of of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.EAST or SwingConstants.WEST

paint

public void paint(Graphics g)

Description copied from class: JComponent

Invoked by Swing to draw components. Applications should not invoke paint directly, but should instead use the repaint method to schedule the component for redrawing.

This method actually delegates the work of painting to three protected methods: paintComponent, paintBorder, and paintChildren. They're called in the order listed to ensure that children appear on top of component itself. Generally speaking, the component and its children should not paint in the insets area allocated to the border. Subclasses can just override this method, as always. A subclass that just wants to specialize the UI (look and feel) delegate's paint method should just override paintComponent.

Overrides:

paint in class JComponent

Parameters:

g - the Graphics context in which to paint

See Also:

JComponent.paintComponent(java.awt.Graphics) , JComponent.paintBorder(java.awt.Graphics) , JComponent.paintChildren(java.awt.Graphics) , JComponent.getComponentGraphics(java.awt.Graphics) , JComponent.repaint(long, int, int, int, int)

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size of the BasicArrowButton. Description copied from class: JComponent

If the preferredSize has been set to a non-null value just returns it. If the UI delegate's getPreferredSize method returns a non null value then return that; otherwise defer to the component's layout manager.

Overrides:

getPreferredSize in class JComponent

Returns:

the preferred size the value of the preferredSize property

See Also:

JComponent.setPreferredSize(java.awt.Dimension) , ComponentUI

getMinimumSize

public Dimension getMinimumSize()

Returns the minimum size of the BasicArrowButton. Description copied from class: JComponent

If the minimum size has been set to a non-null value just returns it. If the UI delegate's getMinimumSize method returns a non-null value then return that; otherwise defer to the component's layout manager.

Overrides:

getMinimumSize in class JComponent

Returns:

the minimum size the value of the minimumSize property

See Also:

JComponent.setMinimumSize(java.awt.Dimension) , ComponentUI

getMaximumSize

public Dimension getMaximumSize()

Returns the maximum size of the BasicArrowButton. Description copied from class: JComponent

If the maximum size has been set to a non-null value just returns it. If the UI delegate's getMaximumSize method returns a non-null value then return that; otherwise defer to the component's layout manager.

Overrides:

getMaximumSize in class JComponent

Returns:

the maximum size the value of the maximumSize property

See Also:

JComponent.setMaximumSize(java.awt.Dimension) , ComponentUI

isFocusTraversable

public boolean isFocusTraversable()

Returns whether the arrow button should get the focus. BasicArrowButtons are used as a child component of composite components such as JScrollBar and JComboBox. Since the composite component typically gets the focus, this method is overriden to return false. Description copied from class: Component

Returns whether this Component can become the focus owner.

Overrides:

isFocusTraversable in class Component

Returns:

false true if this Component is focusable; false otherwise

See Also:

Component.setFocusable(boolean)

paintTriangle

public void paintTriangle(Graphics g,
                          int x,
                          int y,
                          int size,
                          int direction,
                          boolean isEnabled)

Paints a triangle.

Parameters:

g - the Graphics to draw to

x - the x coordinate

y - the y coordinate

size - the size of the triangle to draw

direction - the direction in which to draw the arrow; one of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.EAST or SwingConstants.WEST

isEnabled - whether or not the arrow is drawn enabled