1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
|
package com.explodingpixels.macwidgets.plaf;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Insets;
import java.awt.LayoutManager;
import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.geom.GeneralPath;
import javax.swing.AbstractButton;
import javax.swing.BorderFactory;
import javax.swing.ButtonModel;
import javax.swing.DefaultButtonModel;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.ListCellRenderer;
import javax.swing.SwingConstants;
import javax.swing.event.PopupMenuEvent;
import javax.swing.event.PopupMenuListener;
import javax.swing.plaf.basic.BasicComboBoxUI;
import javax.swing.plaf.basic.ComboPopup;
import com.explodingpixels.macwidgets.HudWidgetFactory;
import com.explodingpixels.macwidgets.WidgetBaseColors;
import com.explodingpixels.widgets.plaf.EPComboPopup;
/**
* Creates a Heads Up Display (HUD) style combo box, similar to that seen in various iApps (e.g.
* iPhoto).
* <br>
* <img src="../../../../../graphics/HUDComboBoxUI.png">
*/
public class HudComboBoxUI extends BasicComboBoxUI {
private HudButtonUI fArrowButtonUI;
private ActionListener fSelectedItemChangedActionListener = createSelectedItemChangedActionListener();
private PopupMenuListener fPopupMenuListener = createPopupMenuListener();
private static final int LEFT_MARGIN = 7;
private static final int RIGHT_MARGIN = 19;
private static final int DEFAULT_WIDTH = 100;
private boolean isDarkColorScheme = true;
/**
* Creates a HUD style {@link javax.swing.plaf.ComboBoxUI}.
*/
public HudComboBoxUI() {
fArrowButtonUI = new HudButtonUI(HudPaintingUtils.Roundedness.COMBO_BUTTON, this);
}
/**
* Creates a HUD style {@link javax.swing.plaf.ComboBoxUI}.
*/
public HudComboBoxUI(boolean isDarkColorScheme) {
this.isDarkColorScheme = isDarkColorScheme;
fArrowButtonUI = new HudButtonUI(HudPaintingUtils.Roundedness.COMBO_BUTTON, this, this.isDarkColorScheme);
}
@Override
protected void installDefaults() {
super.installDefaults();
HudPaintingUtils.initHudComponent(comboBox, isDarkColorScheme);
}
@Override
protected void installListeners() {
super.installListeners();
comboBox.addActionListener(createComboBoxListener());
comboBox.addActionListener(fSelectedItemChangedActionListener);
comboBox.addPopupMenuListener(fPopupMenuListener);
}
@Override
protected void uninstallListeners() {
comboBox.removeActionListener(fSelectedItemChangedActionListener);
}
@Override
protected void uninstallDefaults() {
super.uninstallDefaults();
// TODO implement this.
}
@Override
protected void installComponents() {
super.installComponents();
updateDisplayedItem();
}
/**
* Creates an {@link ActionListener} that udpates the displayed item in the {@code arrowButton}.
* NOTE: This listener doesn't seem to be required on Mac OS X, but Windows does. The selected
* item is not correctly reflected in the UI without this listener.
*/
private ActionListener createSelectedItemChangedActionListener() {
return new ActionListener() {
public void actionPerformed(ActionEvent e) {
updateDisplayedItem();
}
};
}
/**
* Updates the value displayed to match that of {@link JComboBox#getSelectedItem()}.
*/
private void updateDisplayedItem() {
// TODO make the calculation of the display string more robust
// TODO (i.e. use TextProvider interface).
String displayValue = comboBox.getSelectedItem() == null
? " " : comboBox.getSelectedItem().toString();
arrowButton.setText(displayValue);
comboBox.invalidate();
}
/**
* Creates a {@link EPComboPopup.ComboBoxVerticalCenterProvider} that returns a vertical
* center value that takes HudComboBoxUI's drop shadow. The visual center is calculated as if
* the drop shadow did not exist.
*/
private EPComboPopup.ComboBoxVerticalCenterProvider createComboBoxVerticalCenterProvider() {
return new EPComboPopup.ComboBoxVerticalCenterProvider() {
public int provideCenter(JComboBox comboBox) {
return calculateArrowButtonVisualVerticalCenter();
}
};
}
/**
* Creates an {@link ActionListener} that updates the displayed item when the
* {@link JComboBox}'s currently selected item changes.
*/
private ActionListener createComboBoxListener() {
return new ActionListener() {
public void actionPerformed(ActionEvent e) {
updateDisplayedItem();
}
};
}
/**
* Creates a {@link PopupMenuListener} that forces the associated combo box button to be pressed when the combo
* popup is shown and to be non-pressed when the combo popup is hidden.
*/
private PopupMenuListener createPopupMenuListener() {
return new PopupMenuListener() {
public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
arrowButton.getModel().setPressed(true);
}
public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
arrowButton.getModel().setPressed(false);
}
public void popupMenuCanceled(PopupMenuEvent e) {
// no implementation.
}
};
}
@Override
protected JButton createArrowButton() {
JButton arrowButton = new JButton("");
arrowButton.setModel(createButtonModel());
arrowButton.setUI(fArrowButtonUI);
Insets currentInsets = arrowButton.getInsets();
arrowButton.setBorder(BorderFactory.createEmptyBorder(
currentInsets.top, LEFT_MARGIN, currentInsets.bottom, RIGHT_MARGIN));
arrowButton.setHorizontalAlignment(SwingConstants.LEFT);
return arrowButton;
}
/**
* Creates a custom {@link ButtonModel} that forces the button to be in the pressed state if the corresponding
* combo boxe's poup is showing.
*/
private ButtonModel createButtonModel() {
return new DefaultButtonModel() {
@Override
public boolean isPressed() {
return super.isPressed() || isPopupVisible(comboBox);
}
};
}
@Override
protected ListCellRenderer createRenderer() {
return new JComboBox().getRenderer();
}
@Override
protected ComboPopup createPopup() {
EPComboPopup popup = new EPComboPopup(comboBox);
popup.setFont(HudPaintingUtils.getHudFont().deriveFont(Font.PLAIN));
// install a custom ComboBoxVerticalCenterProvider that takes into account the size of the
// drop shadow.
popup.setVerticalComponentCenterProvider(createComboBoxVerticalCenterProvider());
return popup;
}
@Override
public Dimension getMinimumSize(JComponent c) {
int width = getDisplaySize().width;
int height = arrowButton.getPreferredSize().height;
return new Dimension(width, height);
}
@Override
protected Dimension getDefaultSize() {
AbstractButton button = HudWidgetFactory.createHudButton("Button");
return new Dimension(DEFAULT_WIDTH, button.getPreferredSize().height);
}
@Override
public void paint(Graphics g, JComponent c) {
HudPaintingUtils.updateGraphicsToPaintDisabledControlIfNecessary((Graphics2D) g, c);
super.paint(g, c);
Graphics2D graphics = (Graphics2D) g.create();
paintUpDownArrowsIcon(graphics);
graphics.dispose();
}
@Override
public void paintCurrentValue(Graphics g, Rectangle bounds, boolean hasFocus) {
// no painting necessary - the arrowButton handles painting of the currently selected value.
}
@Override
protected Dimension getDisplaySize() {
int maxWidth;
if (comboBox.getPrototypeDisplayValue() != null) {
maxWidth = getDisplayWidth(comboBox.getPrototypeDisplayValue());
} else if (comboBox.getItemCount() > 0) {
maxWidth = getMaxComboBoxModelDisplayWidth();
} else {
maxWidth = getDefaultSize().width;
}
Insets arrowButtonInsets = arrowButton.getInsets();
maxWidth += arrowButtonInsets.left + arrowButtonInsets.right;
return new Dimension(maxWidth, arrowButton.getPreferredSize().height);
}
/**
* Gets the max display width in pixels of all entries in the {@link JComboBox}'s
* {@link javax.swing.ComboBoxModel}.
*/
private int getMaxComboBoxModelDisplayWidth() {
int maxWidth = 0;
for (int i = 0; i < comboBox.getModel().getSize(); i++) {
int itemWidth = getDisplayWidth(comboBox.getModel().getElementAt(i));
maxWidth = Math.max(maxWidth, itemWidth);
}
return maxWidth;
}
/**
* Calculates the display width in pixels of the given object.
*/
private int getDisplayWidth(Object object) {
assert object != null : "The given object cannot be null";
// TODO refactor this logic into utility class that looks for TextProvider.
FontMetrics fontMetrics = comboBox.getFontMetrics(comboBox.getFont());
return fontMetrics.stringWidth(object.toString());
}
@Override
protected LayoutManager createLayoutManager() {
return new LayoutManager() {
public void addLayoutComponent(String name, Component comp) {
throw new UnsupportedOperationException("This operation is not supported.");
}
public void removeLayoutComponent(Component comp) {
throw new UnsupportedOperationException("This operation is not supported.");
}
public Dimension preferredLayoutSize(Container parent) {
// the combo box's preferred size is the preferred width of the parent and the
// preferred height of the arrowButton.
return new Dimension(parent.getPreferredSize().width,
arrowButton.getPreferredSize().height);
}
public Dimension minimumLayoutSize(Container parent) {
return parent.getMinimumSize();
}
public void layoutContainer(Container parent) {
// make the arrowButton fill the width, and center itself in the available height.
int buttonHeight = arrowButton.getPreferredSize().height;
int y = parent.getHeight() / 2 - buttonHeight / 2;
arrowButton.setBounds(0, y, parent.getWidth(), buttonHeight);
}
};
}
/**
* Calculates the visual vertical center of this component. The visual center is what the user
* would interpret as the center, thus we adjust the actual center to take into account the size
* of the drop shadow.
*/
private int calculateArrowButtonVisualVerticalCenter() {
int arrowButtonShadowHeight = HudPaintingUtils.getHudControlShadowSize(arrowButton);
return (comboBox.getHeight() - arrowButtonShadowHeight) / 2;
}
/**
* Paints the up and down arrows on the right side of the combo box.
*/
private void paintUpDownArrowsIcon(Graphics2D graphics) {
Insets arrowButtonInsets = arrowButton.getInsets();
int arrowButtonHeight = arrowButton.getHeight();
// calculate the exact center of where both arrows will be drawn relative to.
int centerX = arrowButton.getWidth() - arrowButtonInsets.right / 2;
int centerY = calculateArrowButtonVisualVerticalCenter();
// calculate how many pixels there should be between the arrows as well as how long each
// side of the arrow should be.
int verticalDistanceBetweenArrows = (int) (arrowButtonHeight * 0.125);
int arrowSideLength = verticalDistanceBetweenArrows * 2;
// calculate the upper left position of the up arrow.
int upArrowX = centerX - arrowSideLength / 2;
int upArrowY = centerY - verticalDistanceBetweenArrows / 2;
graphics.setColor(this.isDarkColorScheme ? WidgetBaseColors.DARK_FONT_COLOR : WidgetBaseColors.LIGHT_FONT_COLOR);
graphics.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
// translate the graphics to the upper left of each arrow and draw that arrow. each arrow
// assumes that it is being drawn at 0,0.
graphics.translate(upArrowX, upArrowY);
graphics.fill(createUpArrow(arrowSideLength));
graphics.translate(0, verticalDistanceBetweenArrows);
graphics.fill(createDownArrow(arrowSideLength));
}
/**
* Creates a path representing an up arrow, based at 0,0.
*/
private static GeneralPath createUpArrow(int arrowSideLength) {
GeneralPath path = new GeneralPath();
path.moveTo(0, 0);
path.lineTo(arrowSideLength, 0);
path.lineTo(arrowSideLength / 2, -arrowSideLength);
path.closePath();
return path;
}
/**
* Creates a path representing a down arrow, based at 0,0.
*/
private static GeneralPath createDownArrow(int arrowSideLength) {
GeneralPath path = new GeneralPath();
path.moveTo(0, 0);
path.lineTo(arrowSideLength, 0);
path.lineTo(arrowSideLength / 2, arrowSideLength);
path.closePath();
return path;
}
}
|