public class

BasicArrowButton

extends JButton
implements SwingConstants
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.AbstractButton
           ↳ javax.swing.JButton
             ↳ javax.swing.plaf.basic.BasicArrowButton
Known Direct Subclasses

Class Overview

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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

[Expand]
Inherited Constants
From class javax.swing.AbstractButton
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.SwingConstants
Fields
protected int direction The direction of the arrow.
[Expand]
Inherited Fields
From class javax.swing.AbstractButton
From class javax.swing.JComponent
Public Constructors
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.
BasicArrowButton(int direction)
Creates a BasicArrowButton whose arrow is drawn in the specified direction.
Public Methods
int getDirection()
Returns the direction of the arrow.
Dimension getMaximumSize()
Returns the maximum size of the BasicArrowButton.
Dimension getMinimumSize()
Returns the minimum size of the BasicArrowButton.
Dimension getPreferredSize()
Returns the preferred size of the BasicArrowButton.
boolean isFocusTraversable()
This method is deprecated. As of 1.4, replaced by isFocusable().
void paint(Graphics g)
Invoked by Swing to draw components.
void paintTriangle(Graphics g, int x, int y, int size, int direction, boolean isEnabled)
Paints a triangle.
void setDirection(int direction)
Sets the direction of the arrow.
[Expand]
Inherited Methods
From class javax.swing.JButton
From class javax.swing.AbstractButton
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.ItemSelectable
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible

Fields

protected int direction

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

Public Constructors

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

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

Public Methods

public int getDirection ()

Returns the direction of the arrow.

public Dimension getMaximumSize ()

Returns the maximum size of the BasicArrowButton.

Returns
  • the maximum size

public Dimension getMinimumSize ()

Returns the minimum size of the BasicArrowButton.

Returns
  • the minimum size

public Dimension getPreferredSize ()

Returns the preferred size of the BasicArrowButton.

Returns
  • the preferred size

public boolean isFocusTraversable ()

This method is deprecated.
As of 1.4, replaced by isFocusable().

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.

Returns
  • false

public void paint (Graphics g)

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.

Parameters
g the Graphics context in which to paint

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

public void setDirection (int direction)

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