Package nz.ac.waikato.cms.gui.core

Class BaseSplitButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

nz.ac.waikato.cms.gui.core.BasePanel

nz.ac.waikato.cms.gui.core.BaseSplitButton

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class BaseSplitButton
extends BasePanel

Simple version of a split button: button + drop-down menu.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected JButton	m_ButtonMain	the main button.
protected BaseButtonWithDropDownMenu	m_ButtonMenu	the menu button.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
BaseSplitButton()	Creates a button with no set text or icon.
BaseSplitButton(String text)	Creates a button with text.
BaseSplitButton(String text, Icon icon)	Creates a button with initial text and an icon.
BaseSplitButton(Action a)	Creates a button where properties are taken from the Action supplied.
BaseSplitButton(Icon icon)	Creates a button with an icon.

Method Summary

Modifier and Type	Method	Description
void	add(Action value)	Adds the menu action.
void	add(JMenuItem value)	Adds the menu item.
void	addChangeListener(ChangeListener l)	Adds the change listener to the menu button.
void	addSeparator()	Adds a menu separator.
Action	getAction()	Returns the action of the main button.
Icon	getIcon()	Returns the icon of the main button.
String	getText()	Returns the text of the main button.
protected void	initGUI()	Initializes the widgets.
boolean	isAlwaysDropdown()	Only for backwards compatibility with old JideSplitButton.
boolean	isButtonEnabled()	Returns the state of the button part of the JideSplitButton.
void	removeChangeListener(ChangeListener l)	Removes the change listener from the menu button.
void	setAction(Action value)	Sets the action for the main button.
void	setAlwaysDropdown(boolean alwaysDropdown)	Only for backwards compatibility with old JideSplitButton.
void	setButtonEnabled(boolean value)	Sets the state of the button part of the JideSplitButton.
void	setEnabled(boolean value)	Sets the enabled state.
void	setIcon(Icon value)	Sets the icon for the main button.
void	setText(String value)	Sets the text for the main button.

Methods inherited from class nz.ac.waikato.cms.gui.core.BasePanel

finishInit, initialize

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

m_ButtonMain

protected JButton m_ButtonMain

the main button.

m_ButtonMenu

protected BaseButtonWithDropDownMenu m_ButtonMenu

the menu button.

Constructor Details

BaseSplitButton

public BaseSplitButton()

Creates a button with no set text or icon.

BaseSplitButton

public BaseSplitButton(Icon icon)

Creates a button with an icon.

Parameters:

icon - the Icon image to display on the button

BaseSplitButton

public BaseSplitButton(String text)

Creates a button with text.

Parameters:

text - the text of the button

BaseSplitButton

public BaseSplitButton(Action a)

Creates a button where properties are taken from the Action supplied.

Parameters:

a - the Action used to specify the new button

Since:

1.3

BaseSplitButton

public BaseSplitButton(String text,
 Icon icon)

Creates a button with initial text and an icon.

Parameters:

text - the text of the button

icon - the Icon image to display on the button

Method Details

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

setText

public void setText(String value)

Sets the text for the main button.

Parameters:

value - the text

getText

public String getText()

Returns the text of the main button.

Returns:

the text

setIcon

public void setIcon(Icon value)

Sets the icon for the main button.

Parameters:

value - the icon

getIcon

public Icon getIcon()

Returns the icon of the main button.

Returns:

the icon

setAction

public void setAction(Action value)

Sets the action for the main button.

Parameters:

value - the action to use

getAction

public Action getAction()

Returns the action of the main button.

Returns:

the action in use, can be null

add

public void add(Action value)

Adds the menu action.

Parameters:

value - the action to add

add

public void add(JMenuItem value)

Adds the menu item.

Parameters:

value - the item to add

addSeparator

public void addSeparator()

Adds a menu separator.

isButtonEnabled

public boolean isButtonEnabled()

Returns the state of the button part of the JideSplitButton. True if the button is enabled, false if it's not.

Returns:

true if the button is enabled, otherwise false

setButtonEnabled

public void setButtonEnabled(boolean value)

Sets the state of the button part of the JideSplitButton.

Parameters:

value - true if the button is enabled, otherwise false

isAlwaysDropdown

public boolean isAlwaysDropdown()

Only for backwards compatibility with old JideSplitButton.

Returns:

always false

setAlwaysDropdown

public void setAlwaysDropdown(boolean alwaysDropdown)

Only for backwards compatibility with old JideSplitButton.

Parameters:

alwaysDropdown - ignored

setEnabled

public void setEnabled(boolean value)

Sets the enabled state.

Overrides:

setEnabled in class JComponent

Parameters:

value - whether enabled or not

addChangeListener

public void addChangeListener(ChangeListener l)

Adds the change listener to the menu button.

Parameters:

l - the listener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes the change listener from the menu button.

Parameters:

l - the listener to remove