buoy.widget

Class BButton


public class BButton
extends Widget

A BButton is a pushbutton Widget. Its appearance can be customized by setting the text and/or image which appears on it.

In addition to the event types generated by all Widgets, BButtons generate the following event types:

Author:
Peter Eastman

Nested Class Summary

static class
BButton.Position
This inner class represents a value for the alignment or text position.

Field Summary

static BButton.Position
CENTER
static BButton.Position
EAST
static BButton.Position
NORTH
static BButton.Position
NORTHEAST
static BButton.Position
NORTHWEST
static BButton.Position
SOUTH
static BButton.Position
SOUTHEAST
static BButton.Position
SOUTHWEST
static BButton.Position
WEST

Constructor Summary

BButton()
Create a new BButton with no set text or image.
BButton(Icon icon)
Create a new BButton.
BButton(String text)
Create a new BButton.
BButton(String text, Icon icon)
Create a new BButton.

Method Summary

String
getActionCommand()
Get the "action command" which will be sent in a CommandEvent when this button is pressed.
JButton
getComponent()
Icon
getIcon()
Get the image being displayed on the button.
Dimension
getMaximumSize()
Get the largest size at which this Widget can reasonably be drawn.
String
getText()
Get the text being displayed on the button.
BButton.Position
getTextPosition()
Get the position of the text relative to the image.
void
setActionCommand(String command)
Set the "action command" which will be sent in a CommandEvent when this button is pressed.
void
setIcon(Icon icon)
Set the image being displayed on the button.
void
setText(String text)
Set the text being displayed on the button.
void
setTextPosition(BButton.Position position)
Set the position of the text relative to the image.

Methods inherited from class buoy.widget.Widget

addEventLink, dispatchEvent, getBackground, getBounds, getComponent, getCursor, getFont, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, hasFocus, isEnabled, isFocusable, isVisible, repaint, requestFocus, setBackground, setCursor, setEnabled, setFocusable, setFont, setName, setVisible

Methods inherited from class buoy.event.EventSource

addEventLink, addEventLink, addEventLink, dispatchEvent, removeEventLink

Field Details

CENTER

public static final BButton.Position CENTER

EAST

public static final BButton.Position EAST

NORTH

public static final BButton.Position NORTH

NORTHEAST

public static final BButton.Position NORTHEAST

NORTHWEST

public static final BButton.Position NORTHWEST

SOUTH

public static final BButton.Position SOUTH

SOUTHEAST

public static final BButton.Position SOUTHEAST

SOUTHWEST

public static final BButton.Position SOUTHWEST

WEST

public static final BButton.Position WEST

Constructor Details

BButton

public BButton()
Create a new BButton with no set text or image.

BButton

public BButton(Icon icon)
Create a new BButton.
Parameters:
icon - the image to display on the button

BButton

public BButton(String text)
Create a new BButton.
Parameters:
text - the text to display on the button

BButton

public BButton(String text,
               Icon icon)
Create a new BButton.
Parameters:
text - the text to display on the button
icon - the image to display on the button

Method Details

getActionCommand

public String getActionCommand()
Get the "action command" which will be sent in a CommandEvent when this button is pressed.

getComponent

public JButton getComponent()
Overrides:
getComponent in interface Widget

getIcon

public Icon getIcon()
Get the image being displayed on the button. This may be null.

getMaximumSize

public Dimension getMaximumSize()
Get the largest size at which this Widget can reasonably be drawn. When a WidgetContainer lays out its contents, it will attempt never to make this Widget larger than its maximum size.
Overrides:
getMaximumSize in interface Widget

getText

public String getText()
Get the text being displayed on the button. This may be null.

getTextPosition

public BButton.Position getTextPosition()
Get the position of the text relative to the image. This will be one of the alignment constants defined by this class: CENTER, NORTH, NORTHEAST, EAST, etc.

setActionCommand

public void setActionCommand(String command)
Set the "action command" which will be sent in a CommandEvent when this button is pressed.

setIcon

public void setIcon(Icon icon)
Set the image being displayed on the button. This may be null.

setText

public void setText(String text)
Set the text being displayed on the button. This may be null.

setTextPosition

public void setTextPosition(BButton.Position position)
Set the position of the text relative to the image. This should be one of the alignment constants defined by this class: CENTER, NORTH, NORTHEAST, EAST, etc. If this BButton does not display both text and an image, this method will have no effect.

Written by Peter Eastman.