org.tinymediamanager.ui.components.JSplitButton Maven / Gradle / Ivy
The newest version!
package org.tinymediamanager.ui.components;
import java.awt.AlphaComposite;
import java.awt.Color;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Rectangle;
import java.awt.Toolkit;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionListener;
import java.awt.image.BufferedImage;
import java.io.Serializable;
import java.util.EventListener;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JPopupMenu;
import javax.swing.UIManager;
import javax.swing.event.EventListenerList;
/**
* An implementation of a "split" button.The left side acts like a normal button, right side has a jPopupMenu attached.
* This class raises two events.
*
* - buttonClicked(e); //when the button is clicked
* - splitButtonClicked(e; //when the split part of the button is clicked)
*
* You need to subscribe to SplitButtonActionListener to handle these events.
*
*
* Use as you wish, but an acknowlegement would be appreciated, ;)
*
* Known Issue:
* The 'button part' of the splitbutton is being drawn without the border??? and this is only happening in CDE/Motif and Metal Look and Feels. GTK+
* and nimbus works perfect. No Idea why? if anybody could point out the mistake that'd be nice.My email naveedmurtuza[at]gmail.com
*
* P.S. The fireXXX methods has been directly plagarized from JDK source code, and yes even the javadocs..;)
*
* The border bug in metal L&F is now fixed. Thanks to Hervé Guillaume.
*
* @author Naveed Quadri
*/
public class JSplitButton extends JButton implements MouseMotionListener, MouseListener, ActionListener, Serializable {
private static final long serialVersionUID = -8065804079209078740L;
private int separatorSpacing = 4;
private int splitWidth = 22;
private int arrowSize = 8;
private boolean onSplit;
private Rectangle splitRectangle;
private JPopupMenu popupMenu;
private boolean alwaysDropDown;
private Color arrowColor = Color.BLACK;
private Color disabledArrowColor = Color.GRAY;
private Image image;
protected SplitButtonActionListener splitButtonActionListener = null;
/**
* Creates a button with initial text and an icon.
*
* @param text
* the text of the button
* @param icon
* the Icon image to display on the button
*/
public JSplitButton(String text, Icon icon) {
super(text, icon);
addMouseMotionListener(this);
addMouseListener(this);
addActionListener(this);
}
/**
* Creates a button with text.
*
* @param text
* the text of the button
*/
public JSplitButton(String text) {
this(text, null);
}
/**
* Creates a button with an icon.
*
* @param icon
* the Icon image to display on the button
*/
public JSplitButton(Icon icon) {
this(null, icon);
}
/**
* Creates a button with no set text or icon.
*/
public JSplitButton() {
this(null, null);
}
/**
* Returns the JPopupMenu if set, null otherwise.
*
* @return JPopupMenu
*/
public JPopupMenu getPopupMenu() {
return popupMenu;
}
/**
* Sets the JPopupMenu to be displayed, when the split part of the button is clicked.
*
* @param popupMenu
* the popup menu for the button
*/
public void setPopupMenu(JPopupMenu popupMenu) {
this.popupMenu = popupMenu;
image = null; // to repaint the arrow image
}
/**
* Returns the separatorSpacing. Separator spacing is the space above and below the separator( the line drawn when you hover your mouse over the
* split part of the button).
*
* @return separatorSpacingimage = null; //to repaint the image with the new size
*/
public int getSeparatorSpacing() {
return separatorSpacing;
}
/**
* Sets the separatorSpacing.Separator spacing is the space above and below the separator( the line drawn when you hover your mouse over the split
* part of the button).
*
* @param separatorSpacing
* the separator spacing in pixels
*/
public void setSeparatorSpacing(int separatorSpacing) {
this.separatorSpacing = separatorSpacing;
}
/**
* Show the dropdown menu, if attached, even if the button part is clicked.
*
* @return true if alwaysDropdown, false otherwise.
*/
public boolean isAlwaysDropDown() {
return alwaysDropDown;
}
/**
* Show the dropdown menu, if attached, even if the button part is clicked.
*
* @param alwaysDropDown
* true to show the attached dropdown even if the button part is clicked, false otherwise
*/
public void setAlwaysDropDown(boolean alwaysDropDown) {
this.alwaysDropDown = alwaysDropDown;
}
/**
* Gets the color of the arrow.
*
* @return arrowColor
*/
public Color getArrowColor() {
return arrowColor;
}
/**
* Set the arrow color.
*
* @param arrowColor
* the arrow color
*/
public void setArrowColor(Color arrowColor) {
this.arrowColor = arrowColor;
image = null; // to repaint the image with the new color
}
/**
* gets the disabled arrow color
*
* @return disabledArrowColor color of the arrow if no popup attached.
*/
public Color getDisabledArrowColor() {
return disabledArrowColor;
}
/**
* sets the disabled arrow color
*
* @param disabledArrowColor
* color of the arrow if no popup attached.
*/
public void setDisabledArrowColor(Color disabledArrowColor) {
this.disabledArrowColor = disabledArrowColor;
image = null; // to repaint the image with the new color
}
/**
* Splitwidth is the width of the split part of the button.
*
* @return splitWidth
*/
public int getSplitWidth() {
return splitWidth;
}
/**
* Splitwidth is the width of the split part of the button.
*
* @param splitWidth
* the splitter with in pixels
*/
public void setSplitWidth(int splitWidth) {
this.splitWidth = splitWidth;
}
/**
* gets the size of the arrow.
*
* @return size of the arrow
*/
public int getArrowSize() {
return arrowSize;
}
/**
* sets the size of the arrow
*
* @param arrowSize
* the arrow size in pixels
*/
public void setArrowSize(int arrowSize) {
this.arrowSize = arrowSize;
image = null; // to repaint the image with the new size
}
/**
* Gets the image to be drawn in the split part. If no is set, a new image is created with the triangle.
*
* @return image
*/
public Image getImage() {
if (image != null) {
return image;
}
else {
Graphics2D g;
BufferedImage img = new BufferedImage(arrowSize, arrowSize, BufferedImage.TYPE_INT_RGB);
g = img.createGraphics();
g.setColor(Color.WHITE);
g.fillRect(0, 0, img.getWidth(), img.getHeight());
g.setColor(popupMenu != null ? arrowColor : disabledArrowColor);
// this creates a triangle facing right >
g.fillPolygon(new int[] { 0, 0, arrowSize / 2 }, new int[] { 0, arrowSize, arrowSize / 2 }, 3);
g.dispose();
// rotate it to face downwards
img = rotate(img, 90);
BufferedImage dimg = new BufferedImage(img.getWidth(), img.getHeight(), BufferedImage.TYPE_INT_ARGB);
g = dimg.createGraphics();
g.setComposite(AlphaComposite.Src);
g.drawImage(img, null, 0, 0);
g.dispose();
for (int i = 0; i < dimg.getHeight(); i++) {
for (int j = 0; j < dimg.getWidth(); j++) {
if (dimg.getRGB(j, i) == Color.WHITE.getRGB()) {
dimg.setRGB(j, i, 0x8F1C1C);
}
}
}
image = Toolkit.getDefaultToolkit().createImage(dimg.getSource());
return image;
}
}
/**
* Sets the image to draw instead of the triangle.
*
* @param image
* the image to be drawn insead of the triangle
*/
public void setImage(Image image) {
this.image = image;
}
@Override
protected void paintComponent(Graphics g) {
super.paintComponent(g);
Color oldColor = g.getColor();
splitRectangle = new Rectangle(getWidth() - splitWidth, 0, splitWidth, getHeight());
g.translate(splitRectangle.x, splitRectangle.y);
int mh = getHeight() / 2;
int mw = splitWidth / 2;
g.drawImage(getImage(), mw - arrowSize / 2, mh + 2 - arrowSize / 2, null);
if (onSplit && !alwaysDropDown && popupMenu != null) {
g.setColor(UIManager.getLookAndFeelDefaults().getColor("Button.background"));
g.drawLine(1, separatorSpacing + 2, 1, getHeight() - separatorSpacing - 2);
g.setColor(UIManager.getLookAndFeelDefaults().getColor("Button.shadow"));
g.drawLine(2, separatorSpacing + 2, 2, getHeight() - separatorSpacing - 2);
}
g.setColor(oldColor);
g.translate(-splitRectangle.x, -splitRectangle.y);
}
/**
* Rotates the given image with the specified angle.
*
* @param img
* image to rotate
* @param angle
* angle of rotation
* @return rotated image
*/
private BufferedImage rotate(BufferedImage img, int angle) {
int w = img.getWidth();
int h = img.getHeight();
BufferedImage dimg = new BufferedImage(w, h, img.getType());
Graphics2D g = dimg.createGraphics();
g.rotate(Math.toRadians(angle), w / 2.d, h / 2.d);
g.drawImage(img, null, 0, 0);
return dimg;
}
/**
* Adds an SplitButtonActionListener to the button.
*
* @param l
* the ActionListener to be added
*/
public void addSplitButtonActionListener(SplitButtonActionListener l) {
listenerList.add(SplitButtonActionListener.class, l);
}
/**
* Removes an SplitButtonActionListener from the button. If the listener is the currently set Action for the button, then
* the Action is set to null.
*
* @param l
* the listener to be removed
*/
public void removeSplitButtonActionListener(SplitButtonActionListener l) {
if ((l != null) && (getAction() == l)) {
setAction(null);
}
else {
listenerList.remove(SplitButtonActionListener.class, l);
}
}
@Override
public void mouseMoved(MouseEvent e) {
onSplit = splitRectangle.contains(e.getPoint());
repaint(splitRectangle);
}
@Override
public void actionPerformed(ActionEvent e) {
if (popupMenu == null) {
fireButtonClicked(e);
}
else if (alwaysDropDown) {
popupMenu.show(this, getWidth() - (int) popupMenu.getPreferredSize().getWidth(), getHeight());
fireButtonClicked(e);
}
else if (onSplit) {
popupMenu.show(this, getWidth() - (int) popupMenu.getPreferredSize().getWidth(), getHeight());
fireSplitbuttonClicked(e);
}
else {
fireButtonClicked(e);
}
}
@Override
public void mouseExited(MouseEvent e) {
onSplit = false;
repaint(splitRectangle);
}
//
public void mouseDragged(MouseEvent e) {
}
public void mouseClicked(MouseEvent e) {
}
public void mousePressed(MouseEvent e) {
}
public void mouseReleased(MouseEvent e) {
}
public void mouseEntered(MouseEvent e) {
}
//
/**
* Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the
* event parameter.
*
* @param event
* the ActionEvent object
* @see EventListenerList
*/
private void fireButtonClicked(ActionEvent event) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
ActionEvent e = null;
// Process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length - 2; i >= 0; i -= 2) {
if (listeners[i] == SplitButtonActionListener.class) {
// Lazily create the event:
if (e == null) {
String actionCommand = event.getActionCommand();
if (actionCommand == null) {
actionCommand = getActionCommand();
}
e = new ActionEvent(JSplitButton.this, ActionEvent.ACTION_PERFORMED, actionCommand, event.getWhen(), event.getModifiers());
}
((SplitButtonActionListener) listeners[i + 1]).buttonClicked(e);
}
}
}
/**
* Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the
* event parameter.
*
* @param event
* the ActionEvent object
* @see EventListenerList
*/
private void fireSplitbuttonClicked(ActionEvent event) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
ActionEvent e = null;
// Process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length - 2; i >= 0; i -= 2) {
if (listeners[i] == SplitButtonActionListener.class) {
// Lazily create the event:
if (e == null) {
String actionCommand = event.getActionCommand();
if (actionCommand == null) {
actionCommand = getActionCommand();
}
e = new ActionEvent(JSplitButton.this, ActionEvent.ACTION_PERFORMED, actionCommand, event.getWhen(), event.getModifiers());
}
((SplitButtonActionListener) listeners[i + 1]).splitButtonClicked(e);
}
}
}
/**
* The listener interface for receiving action events. The class that is interested in processing an action event implements this interface, and the
* object created with that class is registered with a component, using the component's addSplitButtonActionListener method. When the
* action event occurs, that object's buttonClicked or splitButtonClicked method is invoked.
*
* @see ActionEvent
*
* @author Naveed Quadri
*/
public interface SplitButtonActionListener extends EventListener {
/**
* Invoked when the button part is clicked.
*/
void buttonClicked(ActionEvent e);
/**
* Invoked when split part is clicked.
*/
void splitButtonClicked(ActionEvent e);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy