Class ButtonEvent

java.lang.Object
java.util.EventObject
com.jidesoft.dialog.ButtonEvent
All Implemented Interfaces:
Serializable

public class ButtonEvent extends EventObject
An EventObject used to change the state of any button.
See Also:
  • Field Details

    • BUTTON_EVENT_FIRST

      public static final int BUTTON_EVENT_FIRST
      The first number in the range of IDs used for ButtonEvent.
      See Also:
    • BUTTON_EVENT_LAST

      public static final int BUTTON_EVENT_LAST
      The last number in the range of IDs used for DockableFrame events.
      See Also:
    • SHOW_BUTTON

      public static final int SHOW_BUTTON
      This event is fired when you want to show the button.
      See Also:
    • HIDE_BUTTON

      public static final int HIDE_BUTTON
      This event is fired when you want to hide the button.
      See Also:
    • ENABLE_BUTTON

      public static final int ENABLE_BUTTON
      This event is fired when you want to enable the button.
      See Also:
    • DISABLE_BUTTON

      public static final int DISABLE_BUTTON
      This event is fired when you want to disable the button.
      See Also:
    • CHANGE_BUTTON_TEXT

      public static final int CHANGE_BUTTON_TEXT
      This event is fired when you want to change the text of the button.
      See Also:
    • CHANGE_BUTTON_MNEMONIC

      public static final int CHANGE_BUTTON_MNEMONIC
      This event is fired when you want to change the mnemonic of the button.
      See Also:
    • CHANGE_BUTTON_TOOLTIP

      public static final int CHANGE_BUTTON_TOOLTIP
      This event is fired when you want to change the tooltip of the button.
      See Also:
    • CHANGE_BUTTON_FOCUS

      public static final int CHANGE_BUTTON_FOCUS
      This event is fired when you want to set focus to the button.
      See Also:
    • SET_DEFAULT_BUTTON

      public static final int SET_DEFAULT_BUTTON
      This event is fired when you want to set the button to the default button in a root pane.
      See Also:
    • CLEAR_DEFAULT_BUTTON

      public static final int CLEAR_DEFAULT_BUTTON
      This event is fired when you want to clear the default button from a root pane.
      See Also:
  • Constructor Details

    • ButtonEvent

      public ButtonEvent(Object source, int id, String buttonName)
      Creates a ButtonEvent with source, id and the button name.
      Parameters:
      source -
      id -
      buttonName -
    • ButtonEvent

      public ButtonEvent(Object source, int id, String buttonName, String userObject)
      Creates a ButtonEvent with source, id, the button name and a user object. User object is required for CHANGE_BUTTON_TEXT and CHANGE_BUTTON_TOOLTIP event.
      Parameters:
      source -
      id -
      buttonName -
      userObject -
  • Method Details

    • getID

      public int getID()
      Returns the event id.
      Returns:
      event id.
    • setID

      public void setID(int id)
      Sets the event id.
      Parameters:
      id -
    • getButtonName

      public String getButtonName()
      Gets the button name of this event object.
      Returns:
      the button name.
    • setButtonName

      public void setButtonName(String buttonName)
      Sets the button name.
      Parameters:
      buttonName -
    • getUserObject

      public String getUserObject()
      Gets the user object of this event object.
      Returns:
      the user object.
    • setUserObject

      public void setUserObject(String userObject)
      Sets the user object.
      Parameters:
      userObject -
    • paramString

      public String paramString()
      Returns a parameter string identifying this event. This method is useful for event logging and for debugging.
      Returns:
      a string identifying the event and its attributes