javax.swing.AbstractButton — clojure-interop/javax.swing 1.0.5

Defines common behaviors for buttons and menu items.

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions, a section in The Java Tutorial.

For further information see How to Use Buttons, Check Boxes, and Radio Buttons, a section in The Java Tutorial.

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

*-border-painted-changed-property clj

Static Constant.

Identifies a change to having the border drawn, or having it not drawn.

type: java.lang.String

*-content-area-filled-changed-property clj

Static Constant.

Identifies a change to having the button paint the content area.

type: java.lang.String

*-disabled-icon-changed-property clj

Static Constant.

Identifies a change to the icon used when the button has been disabled.

type: java.lang.String

*-disabled-selected-icon-changed-property clj

Static Constant.

Identifies a change to the icon used when the button has been disabled and selected.

type: java.lang.String

*-focus-painted-changed-property clj

Static Constant.

Identifies a change to having the border highlighted when focused, or not.

type: java.lang.String

*-horizontal-alignment-changed-property clj

Static Constant.

Identifies a change in the button's horizontal alignment.

type: java.lang.String

*-horizontal-text-position-changed-property clj

Static Constant.

Identifies a change in the button's horizontal text position.

type: java.lang.String

*-icon-changed-property clj

Static Constant.

Identifies a change to the icon that represents the button.

type: java.lang.String

*-margin-changed-property clj

Static Constant.

Identifies a change in the button's margins.

type: java.lang.String

*-mnemonic-changed-property clj

Static Constant.

Identifies a change to the button's mnemonic.

type: java.lang.String

*-model-changed-property clj

Static Constant.

Identifies a change in the button model.

type: java.lang.String

*-pressed-icon-changed-property clj

Static Constant.

Identifies a change to the icon used when the button has been pressed.

type: java.lang.String

*-rollover-enabled-changed-property clj

Static Constant.

Identifies a change from rollover enabled to disabled or back to enabled.

type: java.lang.String

*-rollover-icon-changed-property clj

Static Constant.

Identifies a change to the icon used when the cursor is over the button.

type: java.lang.String

*-rollover-selected-icon-changed-property clj

Static Constant.

Identifies a change to the icon used when the cursor is over the button and it has been selected.

type: java.lang.String

*-selected-icon-changed-property clj

Static Constant.

Identifies a change to the icon used when the button has been selected.

type: java.lang.String

*-text-changed-property clj

Static Constant.

Identifies a change in the button's text.

type: java.lang.String

*-vertical-alignment-changed-property clj

Static Constant.

Identifies a change in the button's vertical alignment.

type: java.lang.String

*-vertical-text-position-changed-property clj

Static Constant.

Identifies a change in the button's vertical text position.

type: java.lang.String

->abstract-button clj

(->abstract-button)

Constructor.

add-action-listener clj

(add-action-listener this l)

Adds an ActionListener to the button.

l - the ActionListener to be added - java.awt.event.ActionListener

add-change-listener clj

(add-change-listener this l)

Adds a ChangeListener to the button.

l - the listener to be added - javax.swing.event.ChangeListener

add-item-listener clj

(add-item-listener this l)

Adds an ItemListener to the checkbox.

l - the ItemListener to be added - java.awt.event.ItemListener

border-painted? clj

(border-painted? this)

Gets the borderPainted property.

returns: the value of the borderPainted property - boolean

content-area-filled? clj

(content-area-filled? this)

Gets the contentAreaFilled property.

returns: the contentAreaFilled property - boolean

do-click clj

(do-click this)

(do-click this press-time)

Programmatically perform a "click". This does the same thing as if the user had pressed and released the button. The button stays visually "pressed" for pressTime milliseconds.

press-time - the time to "hold down" the button, in milliseconds - int

focus-painted? clj

(focus-painted? this)

Gets the paintFocus property.

returns: the paintFocus property - boolean

get-action clj

(get-action this)

Returns the currently set Action for this ActionEvent source, or null if no Action is set.

returns: the Action for this ActionEvent source, or null - javax.swing.Action

get-action-command clj

(get-action-command this)

Returns the action command for this button.

returns: the action command for this button - java.lang.String

get-action-listeners clj

(get-action-listeners this)

Returns an array of all the ActionListeners added to this AbstractButton with addActionListener().

returns: all of the ActionListeners added or an empty array if no listeners have been added - java.awt.event.ActionListener[]

get-change-listeners clj

(get-change-listeners this)

Returns an array of all the ChangeListeners added to this AbstractButton with addChangeListener().

returns: all of the ChangeListeners added or an empty array if no listeners have been added - javax.swing.event.ChangeListener[]

get-disabled-icon clj

(get-disabled-icon this)

Returns the icon used by the button when it's disabled. If no disabled icon has been set this will forward the call to the look and feel to construct an appropriate disabled Icon.

Some look and feels might not render the disabled Icon, in which case they will ignore this.

returns: the disabledIcon property - javax.swing.Icon

get-disabled-selected-icon clj

(get-disabled-selected-icon this)

Returns the icon used by the button when it's disabled and selected. If no disabled selection icon has been set, this will forward the call to the LookAndFeel to construct an appropriate disabled Icon from the selection icon if it has been set and to getDisabledIcon() otherwise.

Some look and feels might not render the disabled selected Icon, in which case they will ignore this.

returns: the disabledSelectedIcon property - javax.swing.Icon

get-displayed-mnemonic-index clj

(get-displayed-mnemonic-index this)

Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.

returns: index representing mnemonic character - int

get-hide-action-text? clj

(get-hide-action-text? this)

Returns the value of the hideActionText property, which determines whether the button displays text from the Action. This is useful only if an Action has been installed on the button.

returns: true if the button's text property should not reflect that of the Action; the default is false - boolean

get-horizontal-alignment clj

(get-horizontal-alignment this)

Returns the horizontal alignment of the icon and text. AbstractButton's default is SwingConstants.CENTER, but subclasses such as JCheckBox may use a different default.

returns: the horizontalAlignment property, one of the following values:

SwingConstants.RIGHT SwingConstants.LEFT SwingConstants.CENTER SwingConstants.LEADING SwingConstants.TRAILING - int

get-horizontal-text-position clj

(get-horizontal-text-position this)

Returns the horizontal position of the text relative to the icon.

returns: the horizontalTextPosition property, one of the following values:

SwingConstants.RIGHT SwingConstants.LEFT SwingConstants.CENTER SwingConstants.LEADING SwingConstants.TRAILING (the default) - int

get-icon clj

(get-icon this)

Returns the default icon.

returns: the default Icon - javax.swing.Icon

get-icon-text-gap clj

(get-icon-text-gap this)

Returns the amount of space between the text and the icon displayed in this button.

returns: an int equal to the number of pixels between the text and the icon. - int

get-item-listeners clj

(get-item-listeners this)

Returns an array of all the ItemListeners added to this AbstractButton with addItemListener().

returns: all of the ItemListeners added or an empty array if no listeners have been added - java.awt.event.ItemListener[]

get-label clj

(get-label this)

Deprecated. - Replaced by getText

returns: a String containing the label - java.lang.String

get-margin clj

(get-margin this)

Returns the margin between the button's border and the label.

returns: an Insets object specifying the margin between the botton's border and the label - java.awt.Insets

get-mnemonic clj

(get-mnemonic this)

Returns the keyboard mnemonic from the the current model.

returns: the keyboard mnemonic from the model - int

get-model clj

(get-model this)

Returns the model that this button represents.

returns: the model property - javax.swing.ButtonModel

get-multi-click-threshhold clj

(get-multi-click-threshhold this)

Gets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events.

returns: the amount of time required between mouse press events to generate corresponding action events - long

get-pressed-icon clj

(get-pressed-icon this)

Returns the pressed icon for the button.

returns: the pressedIcon property - javax.swing.Icon

get-rollover-icon clj

(get-rollover-icon this)

Returns the rollover icon for the button.

returns: the rolloverIcon property - javax.swing.Icon

get-rollover-selected-icon clj

(get-rollover-selected-icon this)

Returns the rollover selection icon for the button.

returns: the rolloverSelectedIcon property - javax.swing.Icon

get-selected-icon clj

(get-selected-icon this)

Returns the selected icon for the button.

returns: the selectedIcon property - javax.swing.Icon

get-selected-objects clj

(get-selected-objects this)

Returns an array (length 1) containing the label or null if the button is not selected.

returns: an array containing 1 Object: the text of the button, if the item is selected; otherwise null - java.lang.Object[]

get-text clj

(get-text this)

Returns the button's text.

returns: the buttons text - java.lang.String

get-ui clj

(get-ui this)

Returns the L&F object that renders this component.

returns: the ButtonUI object - javax.swing.plaf.ButtonUI

get-vertical-alignment clj

(get-vertical-alignment this)

Returns the vertical alignment of the text and icon.

returns: the verticalAlignment property, one of the following values:

SwingConstants.CENTER (the default) SwingConstants.TOP SwingConstants.BOTTOM - int

get-vertical-text-position clj

(get-vertical-text-position this)

Returns the vertical position of the text relative to the icon.

returns: the verticalTextPosition property, one of the following values:

SwingConstants.CENTER (the default) SwingConstants.TOP SwingConstants.BOTTOM - int

image-update clj

(image-update this img infoflags x y w h)

This is overridden to return false if the current Icon's Image is not equal to the passed in Image img.

img - the Image to be compared - java.awt.Image infoflags - flags used to repaint the button when the image is updated and which determine how much is to be painted - int x - the x coordinate - int y - the y coordinate - int w - the width - int h - the height - int

returns: false if the infoflags indicate that the image is completely loaded; true otherwise. - boolean

remove-action-listener clj

(remove-action-listener this l)

Removes an ActionListener from the button. If the listener is the currently set Action for the button, then the Action is set to null.

l - the listener to be removed - java.awt.event.ActionListener

remove-change-listener clj

(remove-change-listener this l)

Removes a ChangeListener from the button.

l - the listener to be removed - javax.swing.event.ChangeListener

remove-item-listener clj

(remove-item-listener this l)

Removes an ItemListener from the button.

l - the ItemListener to be removed - java.awt.event.ItemListener

remove-notify clj

(remove-notify this)

Notifies this component that it no longer has a parent component. When this method is invoked, any KeyboardActions set up in the the chain of parent components are removed. This method is called by the toolkit internally and should not be called directly by programs.

rollover-enabled? clj

(rollover-enabled? this)

Gets the rolloverEnabled property.

returns: the value of the rolloverEnabled property - boolean

selected? clj

(selected? this)

Returns the state of the button. True if the toggle button is selected, false if it's not.

returns: true if the toggle button is selected, otherwise false - boolean

set-action clj

(set-action this a)

Sets the Action. The new Action replaces any previously set Action but does not affect ActionListeners independently added with addActionListener. If the Action is already a registered ActionListener for the button, it is not re-registered.

Setting the Action results in immediately changing all the properties described in Swing Components Supporting Action. Subsequently, the button's properties are automatically updated as the Action's properties change.

This method uses three other methods to set and help track the Action's property values. It uses the configurePropertiesFromAction method to immediately change the button's properties. To track changes in the Action's property values, this method registers the PropertyChangeListener returned by createActionPropertyChangeListener. The default PropertyChangeListener invokes the actionPropertyChanged method when a property in the Action changes.

a - the Action for the AbstractButton, or null - javax.swing.Action

set-action-command clj

(set-action-command this action-command)

Sets the action command for this button.

action-command - the action command for this button - java.lang.String

set-border-painted clj

(set-border-painted this b)

Sets the borderPainted property. If true and the button has a border, the border is painted. The default value for the borderPainted property is true.

Some look and feels might not support the borderPainted property, in which case they ignore this.

b - if true and border property is not null, the border is painted - boolean

set-content-area-filled clj

(set-content-area-filled this b)

Sets the contentAreaFilled property. If true the button will paint the content area. If you wish to have a transparent button, such as an icon only button, for example, then you should set this to false. Do not call setOpaque(false). The default value for the the contentAreaFilled property is true.

This function may cause the component's opaque property to change.

The exact behavior of calling this function varies on a component-by-component and L&F-by-L&F basis.

b - if true, the content should be filled; if false the content area is not filled - boolean

set-disabled-icon clj

(set-disabled-icon this disabled-icon)

Sets the disabled icon for the button.

disabled-icon - the icon used as the disabled image - javax.swing.Icon

set-disabled-selected-icon clj

(set-disabled-selected-icon this disabled-selected-icon)

Sets the disabled selection icon for the button.

disabled-selected-icon - the icon used as the disabled selection image - javax.swing.Icon

set-displayed-mnemonic-index clj

(set-displayed-mnemonic-index this index)

Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic. Not all look and feels may support this. A value of -1 indicates either there is no mnemonic, the mnemonic character is not contained in the string, or the developer does not wish the mnemonic to be displayed.

The value of this is updated as the properties relating to the mnemonic change (such as the mnemonic itself, the text...). You should only ever have to call this if you do not wish the default character to be underlined. For example, if the text was 'Save As', with a mnemonic of 'a', and you wanted the 'A' to be decorated, as 'Save As', you would have to invoke setDisplayedMnemonicIndex(5) after invoking setMnemonic(KeyEvent.VK_A).

index - Index into the String to underline - int

throws: java.lang.IllegalArgumentException - will be thrown if index is >= length of the text, or < -1

set-enabled clj

(set-enabled this b)

Enables (or disables) the button.

b - true to enable the button, otherwise false - boolean

set-focus-painted clj

(set-focus-painted this b)

Sets the paintFocus property, which must be true for the focus state to be painted. The default value for the paintFocus property is true. Some look and feels might not paint focus state; they will ignore this property.

b - if true, the focus state should be painted - boolean

set-hide-action-text clj

(set-hide-action-text this hide-action-text)

Sets the hideActionText property, which determines whether the button displays text from the Action. This is useful only if an Action has been installed on the button.

hide-action-text - true if the button's text property should not reflect that of the Action; the default is false - boolean

set-horizontal-alignment clj

(set-horizontal-alignment this alignment)

Sets the horizontal alignment of the icon and text. AbstractButton's default is SwingConstants.CENTER, but subclasses such as JCheckBox may use a different default.

alignment - the alignment value, one of the following values: SwingConstants.RIGHT SwingConstants.LEFT SwingConstants.CENTER SwingConstants.LEADING SwingConstants.TRAILING - int

throws: java.lang.IllegalArgumentException - if the alignment is not one of the valid values

set-horizontal-text-position clj

(set-horizontal-text-position this text-position)

Sets the horizontal position of the text relative to the icon.

text-position - one of the following values: SwingConstants.RIGHT SwingConstants.LEFT SwingConstants.CENTER SwingConstants.LEADING SwingConstants.TRAILING (the default) - int

throws: java.lang.IllegalArgumentException - if textPosition is not one of the legal values listed above

set-icon clj

(set-icon this default-icon)

Sets the button's default icon. This icon is also used as the "pressed" and "disabled" icon if there is no explicitly set pressed icon.

default-icon - the icon used as the default image - javax.swing.Icon

set-icon-text-gap clj

(set-icon-text-gap this icon-text-gap)

If both the icon and text properties are set, this property defines the space between them.

The default value of this property is 4 pixels.

This is a JavaBeans bound property.

icon-text-gap - int

set-label clj

(set-label this label)

Deprecated. - Replaced by setText(text)

label - a String containing the text - java.lang.String

set-layout clj

(set-layout this mgr)

Sets the layout manager for this container, refer to Container.setLayout(LayoutManager) for a complete description of this method.

mgr - the specified layout manager - java.awt.LayoutManager

set-margin clj

(set-margin this m)

Sets space for margin between the button's border and the label. Setting to null will cause the button to use the default margin. The button's default Border object will use this value to create the proper margin. However, if a non-default border is set on the button, it is that Border object's responsibility to create the appropriate margin space (else this property will effectively be ignored).

m - the space between the border and the label - java.awt.Insets

set-mnemonic clj

(set-mnemonic this mnemonic)

Sets the keyboard mnemonic on the current model. The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate this button if focus is contained somewhere within this button's ancestor window.

A mnemonic must correspond to a single key on the keyboard and should be specified using one of the VK_XXX keycodes defined in java.awt.event.KeyEvent. These codes and the wider array of codes for international keyboards may be obtained through java.awt.event.KeyEvent.getExtendedKeyCodeForChar. Mnemonics are case-insensitive, therefore a key event with the corresponding keycode would cause the button to be activated whether or not the Shift modifier was pressed.

If the character defined by the mnemonic is found within the button's label string, the first occurrence of it will be underlined to indicate the mnemonic to the user.

mnemonic - the key code which represents the mnemonic - int

set-model clj

(set-model this new-model)

Sets the model that this button represents.

new-model - the new ButtonModel - javax.swing.ButtonModel

set-multi-click-threshhold clj

(set-multi-click-threshhold this threshhold)

Sets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events. After the initial mouse press occurs (and action event generated) any subsequent mouse press events which occur on intervals less than the threshhold will be ignored and no corresponding action event generated. By default the threshhold is 0, which means that for each mouse press, an action event will be fired, no matter how quickly the mouse clicks occur. In buttons where this behavior is not desirable (for example, the "OK" button in a dialog), this threshhold should be set to an appropriate positive value.

threshhold - the amount of time required between mouse press events to generate corresponding action events - long

throws: java.lang.IllegalArgumentException - if threshhold < 0

set-pressed-icon clj

(set-pressed-icon this pressed-icon)

Sets the pressed icon for the button.

pressed-icon - the icon used as the "pressed" image - javax.swing.Icon

set-rollover-enabled clj

(set-rollover-enabled this b)

Sets the rolloverEnabled property, which must be true for rollover effects to occur. The default value for the rolloverEnabled property is false. Some look and feels might not implement rollover effects; they will ignore this property.

b - if true, rollover effects should be painted - boolean

set-rollover-icon clj

(set-rollover-icon this rollover-icon)

Sets the rollover icon for the button.

rollover-icon - the icon used as the "rollover" image - javax.swing.Icon

set-rollover-selected-icon clj

(set-rollover-selected-icon this rollover-selected-icon)

Sets the rollover selected icon for the button.

rollover-selected-icon - the icon used as the "selected rollover" image - javax.swing.Icon

set-selected clj

(set-selected this b)

Sets the state of the button. Note that this method does not trigger an actionEvent. Call doClick to perform a programmatic action change.

b - true if the button is selected, otherwise false - boolean

set-selected-icon clj

(set-selected-icon this selected-icon)

Sets the selected icon for the button.

selected-icon - the icon used as the "selected" image - javax.swing.Icon

set-text clj

(set-text this text)

Sets the button's text.

text - the string used to set the text - java.lang.String

set-ui clj

(set-ui this ui)

Sets the L&F object that renders this component.

ui - the ButtonUI L&F object - javax.swing.plaf.ButtonUI

set-vertical-alignment clj

(set-vertical-alignment this alignment)

Sets the vertical alignment of the icon and text.

alignment - one of the following values: SwingConstants.CENTER (the default) SwingConstants.TOP SwingConstants.BOTTOM - int

throws: java.lang.IllegalArgumentException - if the alignment is not one of the legal values listed above

set-vertical-text-position clj

(set-vertical-text-position this text-position)

Sets the vertical position of the text relative to the icon.

text-position - one of the following values: SwingConstants.CENTER (the default) SwingConstants.TOP SwingConstants.BOTTOM - int

update-ui clj

(update-ui this)

Resets the UI property to a value from the current look and feel. Subtypes of AbstractButton should override this to update the UI. For example, JButton might do the following:

 setUI((ButtonUI)UIManager.getUI(
     "ButtonUI", "javax.swing.plaf.basic.BasicButtonUI", this));