{
/**
* Creates a new pair.
*
* @param key
* Pair key.
* @param value
* Pair value.
*/
public StringValuePair(String key, T value) {
super(key, value);
}
}
src/org/pushingpixels/flamingo/api/common/RolloverActionListener.java 0000644 0001750 0001750 00000003655 11401230444 025254 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.event.ActionListener;
/**
* Rollover action listener. Is used to associate application logic with
* rollover of {@link JCommandMenuButton} component.
*
* @author Kirill Grouchnikov
*/
public interface RolloverActionListener extends ActionListener {
}
src/org/pushingpixels/flamingo/api/common/AsynchronousLoading.java 0000644 0001750 0001750 00000005333 11401230444 024570 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.util.concurrent.ExecutorService;
import org.pushingpixels.flamingo.api.svg.SvgBatikResizableIcon;
/**
* This interface is used for asynchronously-loaded contents. For example, the
* {@link SvgBatikResizableIcon} uses the {@link ExecutorService} to load the
* SVG image in the background. When the image is loaded, the component that
* contains this image ({@link JCommandButton} for example) is notified to
* repaint itself.
*
* @author Kirill Grouchnikov.
*/
public interface AsynchronousLoading {
/**
* Adds listener on the asynchronous loading events.
*
* @param l
* Listener to add.
*/
public void addAsynchronousLoadListener(AsynchronousLoadListener l);
/**
* Removes listener on the asynchronous loading events.
*
* @param l
* Listener to remove.
*/
public void removeAsynchronousLoadListener(AsynchronousLoadListener l);
/**
* Returns indication whether the content is still loading.
*
* @return true if the content is still loading,
* false otherwise.
*/
public boolean isLoading();
}
src/org/pushingpixels/flamingo/api/common/RichToolTipManager.java 0000644 0001750 0001750 00000026716 11401230444 024302 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.*;
import java.awt.event.*;
import java.util.List;
import javax.swing.*;
import org.pushingpixels.flamingo.api.common.popup.JPopupPanel;
import org.pushingpixels.flamingo.api.common.popup.PopupPanelManager;
import org.pushingpixels.flamingo.api.ribbon.AbstractRibbonBand;
import org.pushingpixels.flamingo.internal.ui.common.JRichTooltipPanel;
public class RichToolTipManager extends MouseAdapter implements
MouseMotionListener {
private Timer initialDelayTimer;
private Timer dismissTimer;
private RichTooltip richTooltip;
private JTrackableComponent insideComponent;
private MouseEvent mouseEvent;
final static RichToolTipManager sharedInstance = new RichToolTipManager();
private Popup tipWindow;
private JRichTooltipPanel tip;
private boolean tipShowing = false;
private static final String TRACKED_FOR_RICH_TOOLTIP = "flamingo.internal.trackedForRichTooltip";
public static abstract class JTrackableComponent extends JComponent {
public abstract RichTooltip getRichTooltip(MouseEvent mouseEvent);
}
RichToolTipManager() {
initialDelayTimer = new Timer(750, new InitialDelayTimerAction());
initialDelayTimer.setRepeats(false);
dismissTimer = new Timer(20000, new DismissTimerAction());
dismissTimer.setRepeats(false);
}
/**
* Specifies the initial delay value.
*
* @param milliseconds
* the number of milliseconds to delay (after the cursor has
* paused) before displaying the tooltip
* @see #getInitialDelay
*/
public void setInitialDelay(int milliseconds) {
initialDelayTimer.setInitialDelay(milliseconds);
}
/**
* Returns the initial delay value.
*
* @return an integer representing the initial delay value, in milliseconds
* @see #setInitialDelay
*/
public int getInitialDelay() {
return initialDelayTimer.getInitialDelay();
}
/**
* Specifies the dismissal delay value.
*
* @param milliseconds
* the number of milliseconds to delay before taking away the
* tooltip
* @see #getDismissDelay
*/
public void setDismissDelay(int milliseconds) {
dismissTimer.setInitialDelay(milliseconds);
}
/**
* Returns the dismissal delay value.
*
* @return an integer representing the dismissal delay value, in
* milliseconds
* @see #setDismissDelay
*/
public int getDismissDelay() {
return dismissTimer.getInitialDelay();
}
void showTipWindow(MouseEvent mouseEvent) {
if (insideComponent == null || !insideComponent.isShowing())
return;
Dimension size;
Point screenLocation = insideComponent.getLocationOnScreen();
Point location = new Point();
GraphicsConfiguration gc;
gc = insideComponent.getGraphicsConfiguration();
Rectangle sBounds = gc.getBounds();
Insets screenInsets = Toolkit.getDefaultToolkit().getScreenInsets(gc);
// Take into account screen insets, decrease viewport
sBounds.x += screenInsets.left;
sBounds.y += screenInsets.top;
sBounds.width -= (screenInsets.left + screenInsets.right);
sBounds.height -= (screenInsets.top + screenInsets.bottom);
// Just to be paranoid
hideTipWindow();
tip = new JRichTooltipPanel(insideComponent.getRichTooltip(mouseEvent));
tip
.applyComponentOrientation(insideComponent
.getComponentOrientation());
size = tip.getPreferredSize();
AbstractRibbonBand ribbonBand = (AbstractRibbonBand) SwingUtilities
.getAncestorOfClass(AbstractRibbonBand.class, insideComponent);
boolean ltr = tip.getComponentOrientation().isLeftToRight();
boolean isInRibbonBand = (ribbonBand != null);
if (isInRibbonBand) {
// display directly below or above ribbon band
location.x = ltr ? screenLocation.x : screenLocation.x
+ insideComponent.getWidth() - size.width;
Point bandLocationOnScreen = ribbonBand.getLocationOnScreen();
location.y = bandLocationOnScreen.y + ribbonBand.getHeight() + 4;
if ((location.y + size.height) > (sBounds.y + sBounds.height)) {
location.y = bandLocationOnScreen.y - size.height;
}
} else {
// display directly below or above it
location.x = ltr ? screenLocation.x : screenLocation.x
+ insideComponent.getWidth() - size.width;
location.y = screenLocation.y + insideComponent.getHeight();
if ((location.y + size.height) > (sBounds.y + sBounds.height)) {
location.y = screenLocation.y - size.height;
}
}
// Tweak the X location to not overflow the screen
if (location.x < sBounds.x) {
location.x = sBounds.x;
} else if (location.x - sBounds.x + size.width > sBounds.width) {
location.x = sBounds.x + Math.max(0, sBounds.width - size.width);
}
PopupFactory popupFactory = PopupFactory.getSharedInstance();
tipWindow = popupFactory.getPopup(insideComponent, tip, location.x,
location.y);
tipWindow.show();
dismissTimer.start();
tipShowing = true;
}
void hideTipWindow() {
if (tipWindow != null) {
tipWindow.hide();
tipWindow = null;
tipShowing = false;
tip = null;
dismissTimer.stop();
}
}
/**
* Returns a shared ToolTipManager instance.
*
* @return a shared ToolTipManager object
*/
public static RichToolTipManager sharedInstance() {
return sharedInstance;
}
/**
* Registers a component for tooltip management.
*
* This will register key bindings to show and hide the tooltip text only if
* component has focus bindings. This is done so that
* components that are not normally focus traversable, such as
* JLabel, are not made focus traversable as a result of
* invoking this method.
*
* @param comp
* a JComponent object to add
* @see JComponent#isFocusTraversable
*/
public void registerComponent(JTrackableComponent comp) {
if (Boolean.TRUE.equals(comp
.getClientProperty(TRACKED_FOR_RICH_TOOLTIP)))
return;
comp.addMouseListener(this);
// commandButton.addMouseMotionListener(moveBeforeEnterListener);
comp.putClientProperty(TRACKED_FOR_RICH_TOOLTIP, Boolean.TRUE);
}
/**
* Removes a component from tooltip control.
*
* @param comp
* a JComponent object to remove
*/
public void unregisterComponent(JTrackableComponent comp) {
comp.removeMouseListener(this);
comp.putClientProperty(TRACKED_FOR_RICH_TOOLTIP, null);
}
@Override
public void mouseEntered(MouseEvent event) {
initiateToolTip(event);
}
private void initiateToolTip(MouseEvent event) {
JTrackableComponent component = (JTrackableComponent) event.getSource();
// component.removeMouseMotionListener(moveBeforeEnterListener);
Point location = event.getPoint();
// ensure tooltip shows only in proper place
if (location.x < 0 || location.x >= component.getWidth()
|| location.y < 0 || location.y >= component.getHeight()) {
return;
}
// do not show tooltips on components in popup panels that are not
// in the last shown one
List popups = PopupPanelManager
.defaultManager().getShownPath();
if (popups.size() > 0) {
JPopupPanel popupPanel = popups.get(popups.size() - 1)
.getPopupPanel();
boolean ignore = true;
Component c = component;
while (c != null) {
if (c == popupPanel) {
ignore = false;
break;
}
c = c.getParent();
}
if (ignore)
return;
}
if (insideComponent != null) {
initialDelayTimer.stop();
}
// A component in an unactive internal frame is sent two
// mouseEntered events, make sure we don't end up adding
// ourselves an extra time.
component.removeMouseMotionListener(this);
component.addMouseMotionListener(this);
insideComponent = component;
mouseEvent = event;
initialDelayTimer.start();
}
@Override
public void mouseExited(MouseEvent event) {
initialDelayTimer.stop();
if (insideComponent != null) {
insideComponent.removeMouseMotionListener(this);
}
insideComponent = null;
richTooltip = null;
mouseEvent = null;
hideTipWindow();
}
@Override
public void mousePressed(MouseEvent event) {
hideTipWindow();
initialDelayTimer.stop();
insideComponent = null;
mouseEvent = null;
}
@Override
public void mouseDragged(MouseEvent event) {
}
@Override
public void mouseMoved(MouseEvent event) {
if (tipShowing) {
checkForTipChange(event);
} else {
// Lazily lookup the values from within insideTimerAction
insideComponent = (JTrackableComponent) event.getSource();
mouseEvent = event;
richTooltip = null;
initialDelayTimer.restart();
}
}
private void checkForTipChange(MouseEvent event) {
JTrackableComponent component = (JTrackableComponent) event.getSource();
RichTooltip newTooltip = component.getRichTooltip(event);
// is it different?
boolean isDifferent = (richTooltip != newTooltip);
if (isDifferent) {
hideTipWindow();
if (newTooltip != null) {
richTooltip = newTooltip;
initialDelayTimer.restart();
}
}
}
protected class InitialDelayTimerAction implements ActionListener {
public void actionPerformed(ActionEvent e) {
if (insideComponent != null && insideComponent.isShowing()) {
// Lazy lookup
if (richTooltip == null && mouseEvent != null) {
richTooltip = insideComponent.getRichTooltip(mouseEvent);
}
if (richTooltip != null) {
boolean showRichTooltip = true;
// check that no visible popup is originating in this
// component
for (PopupPanelManager.PopupInfo pi : PopupPanelManager
.defaultManager().getShownPath()) {
if (pi.getPopupOriginator() == insideComponent) {
showRichTooltip = false;
break;
}
}
if (showRichTooltip) {
showTipWindow(mouseEvent);
}
} else {
insideComponent = null;
richTooltip = null;
mouseEvent = null;
hideTipWindow();
}
}
}
}
protected class DismissTimerAction implements ActionListener {
public void actionPerformed(ActionEvent e) {
hideTipWindow();
initialDelayTimer.stop();
insideComponent = null;
mouseEvent = null;
}
}
}
src/org/pushingpixels/flamingo/api/common/JCommandMenuButton.java 0000644 0001750 0001750 00000011062 11401230444 024304 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.event.ActionEvent;
import javax.swing.UIManager;
import org.pushingpixels.flamingo.api.common.icon.ResizableIcon;
import org.pushingpixels.flamingo.api.common.popup.JCommandPopupMenu;
import org.pushingpixels.flamingo.internal.ui.common.BasicCommandMenuButtonUI;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI;
/**
* A command button that can be placed in {@link JCommandPopupMenu}s and in the
* primary / secondary panels of the ribbon application menu.
*
* @author Kirill Grouchnikov
* @see JCommandPopupMenu#addMenuButton(JCommandMenuButton)
*/
public class JCommandMenuButton extends JCommandButton {
/**
* The UI class ID string.
*/
public static final String uiClassID = "CommandMenuButtonUI";
/**
* Creates a new command menu button.
*
* @param title
* Command menu button title.
* @param icon
* Command menu button icon.
*/
public JCommandMenuButton(String title, ResizableIcon icon) {
super(title, icon);
}
/**
* Adds a rollover action listener that will be called when the rollover
* state of this button becomes active.
*
* @param l
* The rollover action listener to add.
* @see #removeRolloverActionListener(RolloverActionListener)
*/
public void addRolloverActionListener(RolloverActionListener l) {
this.listenerList.add(RolloverActionListener.class, l);
}
/**
* Removes the specified rollover action listener.
*
* @param l
* The listener to remove.
* @see #addRolloverActionListener(RolloverActionListener)
*/
public void removeRolloverActionListener(RolloverActionListener l) {
this.listenerList.remove(RolloverActionListener.class, l);
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#getUIClassID()
*/
@Override
public String getUIClassID() {
return uiClassID;
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#updateUI()
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((CommandButtonUI) UIManager.getUI(this));
} else {
setUI(BasicCommandMenuButtonUI.createUI(this));
}
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.JCommandButton#canHaveBothKeyTips()
*/
@Override
boolean canHaveBothKeyTips() {
return true;
}
/**
* Programmatically perform a "rollover" on the action area. This does the
* same thing as if the user had moved the mouse over the action area of the
* button.
*/
public void doActionRollover() {
ActionEvent ae = new ActionEvent(this, ActionEvent.ACTION_PERFORMED,
this.getActionModel().getActionCommand());
// Guaranteed to return a non-null array
RolloverActionListener[] listeners = this
.getListeners(RolloverActionListener.class);
// Process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length - 1; i >= 0; i--) {
(listeners[i]).actionPerformed(ae);
}
}
}
src/org/pushingpixels/flamingo/api/common/model/ 0000755 0001750 0001750 00000000000 11401230444 021030 5 ustar tony tony src/org/pushingpixels/flamingo/api/common/model/ActionButtonModel.java 0000644 0001750 0001750 00000005250 11401230444 025267 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.model;
import javax.swing.ButtonModel;
import org.pushingpixels.flamingo.api.common.AbstractCommandButton;
/**
* Model for the action area of {@link AbstractCommandButton} component.
*
* @author Kirill Grouchnikov
*/
public interface ActionButtonModel extends ButtonModel {
/**
* Sets indication whether the associated actions should be fired on mouse
* press instead of mouse release.
*
* @param toFireActionOnPress
* if true, the associated actions will be fired on
* mouse press, otherwise the associated actions will be fired on
* mouse release.
*/
public void setFireActionOnPress(boolean toFireActionOnPress);
/**
* Returns indication whether the associated actions should be fired on
* mouse press instead of mouse release.
*
* @return true if the associated actions are fired on mouse
* press, false if the associated actions are fired on
* mouse release.
*/
public boolean isFireActionOnPress();
} src/org/pushingpixels/flamingo/api/common/model/ActionToggleButtonModel.java 0000644 0001750 0001750 00000010020 11401230444 026420 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.model;
import java.awt.AWTEvent;
import java.awt.EventQueue;
import java.awt.event.ActionEvent;
import java.awt.event.InputEvent;
import javax.swing.JToggleButton.ToggleButtonModel;
import org.pushingpixels.flamingo.api.common.JCommandToggleButton;
/**
* Extension of the default toggle button model that supports the
* {@link ActionButtonModel} interface. This is the default core action model
* set on {@link JCommandToggleButton}s.
*
* @author Kirill Grouchnikov
*/
public class ActionToggleButtonModel extends ToggleButtonModel implements
ActionButtonModel {
/**
* Indication whether the action is fired on mouse press (as opposed to
* mouse release).
*/
protected boolean toFireActionOnPress;
/**
* Creates a new model.
*
* @param toFireActionOnPress
* If true, the action will be fired on mouse press,
* if false, the action will be fired on mouse
* release.
*/
public ActionToggleButtonModel(boolean toFireActionOnPress) {
this.toFireActionOnPress = toFireActionOnPress;
}
@Override
public boolean isFireActionOnPress() {
return this.toFireActionOnPress;
}
@Override
public void setFireActionOnPress(boolean toFireActionOnPress) {
this.toFireActionOnPress = toFireActionOnPress;
}
@Override
public void setPressed(boolean b) {
if ((isPressed() == b) || !isEnabled()) {
return;
}
if (isArmed()) {
// change selection prior to firing the action event
if (!this.isFireActionOnPress()) {
if (!b) {
setSelected(!this.isSelected());
}
} else {
if (b) {
setSelected(!this.isSelected());
}
}
}
if (b) {
stateMask |= PRESSED;
} else {
stateMask &= ~PRESSED;
}
fireStateChanged();
boolean toFireAction = false;
if (this.isFireActionOnPress()) {
toFireAction = isPressed() && isArmed();
} else {
toFireAction = !isPressed() && isArmed();
}
if (toFireAction) {
int modifiers = 0;
AWTEvent currentEvent = EventQueue.getCurrentEvent();
if (currentEvent instanceof InputEvent) {
modifiers = ((InputEvent) currentEvent).getModifiers();
} else if (currentEvent instanceof ActionEvent) {
modifiers = ((ActionEvent) currentEvent).getModifiers();
}
fireActionPerformed(new ActionEvent(this,
ActionEvent.ACTION_PERFORMED, getActionCommand(),
EventQueue.getMostRecentEventTime(), modifiers));
}
}
}
src/org/pushingpixels/flamingo/api/common/model/ActionRepeatableButtonModel.java 0000644 0001750 0001750 00000016660 11401230444 027263 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.model;
import java.awt.AWTEvent;
import java.awt.EventQueue;
import java.awt.event.*;
import javax.swing.DefaultButtonModel;
import javax.swing.Timer;
import org.pushingpixels.flamingo.api.common.JCommandButton;
import org.pushingpixels.flamingo.api.common.JCommandButton.CommandButtonKind;
/**
* Extension of the default button model that supports the
* {@link ActionButtonModel} interface and repeated invocation of action
* listeners on mouse rollover. This is the default core action model set on
* {@link JCommandButton}s.
*
* @author Kirill Grouchnikov
*/
public class ActionRepeatableButtonModel extends DefaultButtonModel implements
ActionButtonModel {
/**
* The button behind the model.
*/
private JCommandButton commandButton;
/**
* Timer for the auto-repeat action mode.
*/
protected Timer autoRepeatTimer;
/**
* Indication whether the action is fired on mouse press (as opposed to
* mouse release).
*/
protected boolean toFireActionOnPress;
/**
* Creates a new button model.
*
* @param commandButton
* The associated command button.
*/
public ActionRepeatableButtonModel(JCommandButton commandButton) {
super();
this.commandButton = commandButton;
this.toFireActionOnPress = false;
}
/*
* (non-Javadoc)
*
* @see javax.swing.DefaultButtonModel#setPressed(boolean)
*/
@Override
public void setPressed(boolean b) {
if ((isPressed() == b) || !isEnabled()) {
return;
}
if (b) {
stateMask |= PRESSED;
} else {
stateMask &= ~PRESSED;
}
boolean toFireFirstAction = isArmed();
// if the button is in auto-repeat action mode, the action
// starts firing on press-down and not on press-up
if (commandButton.isAutoRepeatAction() || isFireActionOnPress())
toFireFirstAction = isPressed() && toFireFirstAction;
else
toFireFirstAction = !isPressed() && toFireFirstAction;
// no action on popup only command buttons
if (commandButton.getCommandButtonKind() == CommandButtonKind.POPUP_ONLY)
toFireFirstAction = false;
if (this.commandButton.isFireActionOnRollover()) {
// the action is invoked on rollover
toFireFirstAction = false;
}
int modifiers = 0;
AWTEvent currentEvent = EventQueue.getCurrentEvent();
if (currentEvent instanceof InputEvent) {
modifiers = ((InputEvent) currentEvent).getModifiers();
} else if (currentEvent instanceof ActionEvent) {
modifiers = ((ActionEvent) currentEvent).getModifiers();
}
if (toFireFirstAction) {
fireActionPerformed(new ActionEvent(this,
ActionEvent.ACTION_PERFORMED, getActionCommand(),
EventQueue.getMostRecentEventTime(), modifiers));
if (commandButton.isAutoRepeatAction()) {
// start timer
this.startActionTimer(modifiers);
}
}
// we need to stop timer when the non-action-on-rollover button
// gets pressed=false and it is in auto-repeat mode
if (!this.commandButton.isFireActionOnRollover()) {
if (this.commandButton.isAutoRepeatAction() && !b) {
this.stopActionTimer();
}
}
fireStateChanged();
}
@Override
public void setRollover(boolean b) {
if ((isRollover() == b) || !isEnabled()) {
return;
}
if (b) {
stateMask |= ROLLOVER;
} else {
stateMask &= ~ROLLOVER;
}
if (this.commandButton.isFireActionOnRollover()) {
if (b
&& !this.isActionTimerRunning()
&& (this.commandButton.getCommandButtonKind() != CommandButtonKind.POPUP_ONLY)) {
// action-on-rollover non-popup-only button that gained
// rollover and the action timer is not running - fire the
// first event and start the action timer.
int modifiers = 0;
AWTEvent currentEvent = EventQueue.getCurrentEvent();
if (currentEvent instanceof InputEvent) {
modifiers = ((InputEvent) currentEvent).getModifiers();
} else if (currentEvent instanceof ActionEvent) {
modifiers = ((ActionEvent) currentEvent).getModifiers();
}
fireActionPerformed(new ActionEvent(this,
ActionEvent.ACTION_PERFORMED, getActionCommand(),
EventQueue.getMostRecentEventTime(), modifiers));
if (commandButton.isAutoRepeatAction()) {
// start timer
this.startActionTimer(modifiers);
}
}
if (!b) {
this.stopActionTimer();
}
}
fireStateChanged();
}
/**
* Stop the action timer.
*/
private void stopActionTimer() {
if (this.autoRepeatTimer != null)
this.autoRepeatTimer.stop();
}
/**
* Checks whether the action timer is running.
*
* @return true if the action timer is running,
* false otherwise.
*/
private boolean isActionTimerRunning() {
if (this.autoRepeatTimer == null)
return false;
return this.autoRepeatTimer.isRunning();
}
/**
* Starts the action timer, passing the specified modifiers to the action
* event that will be fired in a loop.
*
* @param modifiers
* Modifiers for the action event to be fired.
*/
private void startActionTimer(final int modifiers) {
this.autoRepeatTimer = new Timer(this.commandButton
.getAutoRepeatSubsequentInterval(), new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
if (!isEnabled() || !commandButton.isVisible()
|| !commandButton.isDisplayable()) {
// stop the timer when the button becomes
// disabled, invisible or undisplayable
autoRepeatTimer.stop();
return;
}
fireActionPerformed(new ActionEvent(this,
ActionEvent.ACTION_PERFORMED, getActionCommand(),
EventQueue.getMostRecentEventTime(), modifiers));
}
});
this.autoRepeatTimer.setInitialDelay(this.commandButton
.getAutoRepeatInitialInterval());
this.autoRepeatTimer.start();
}
@Override
public boolean isFireActionOnPress() {
return this.toFireActionOnPress;
}
@Override
public void setFireActionOnPress(boolean toFireActionOnPress) {
this.toFireActionOnPress = toFireActionOnPress;
}
} src/org/pushingpixels/flamingo/api/common/model/PopupButtonModel.java 0000644 0001750 0001750 00000005360 11401230444 025157 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.model;
import javax.swing.ButtonModel;
import org.pushingpixels.flamingo.api.common.JCommandButton;
import org.pushingpixels.flamingo.api.common.PopupActionListener;
/**
* Model for the popup area of {@link JCommandButton} component.
*
* @author Kirill Grouchnikov
*/
public interface PopupButtonModel extends ButtonModel {
/**
* Adds an PopupActionListener to the model.
*
* @param l
* the listener to add
*/
void addPopupActionListener(PopupActionListener l);
/**
* Removes an PopupActionListener from the model.
*
* @param l
* the listener to remove
*/
void removePopupActionListener(PopupActionListener l);
/**
* Sets indication on the visibility status of the associated popup.
*
* @param flag
* The visibility status of the associated popup.
*/
void setPopupShowing(boolean flag);
/**
* Returns indication whether the associated popup is showing.
*
* @return true if the associated popup is showing,
* false otherwise.
*/
boolean isPopupShowing();
} src/org/pushingpixels/flamingo/api/common/popup/ 0000755 0001750 0001750 00000000000 11401230444 021073 5 ustar tony tony src/org/pushingpixels/flamingo/api/common/popup/JColorSelectorPopupMenu.java 0000644 0001750 0001750 00000023340 11401230444 026502 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.popup;
import java.awt.*;
import java.util.*;
import java.util.List;
import javax.swing.JPanel;
import org.pushingpixels.flamingo.api.common.JCommandMenuButton;
import org.pushingpixels.flamingo.api.common.JCommandToggleMenuButton;
import org.pushingpixels.flamingo.internal.ui.common.popup.JColorSelectorComponent;
import org.pushingpixels.flamingo.internal.ui.common.popup.JColorSelectorPanel;
public class JColorSelectorPopupMenu extends JCommandPopupMenu {
private ColorSelectorCallback colorSelectorCallback;
private JColorSelectorPanel lastColorSelectorPanel;
private static LinkedList recentlySelected = new LinkedList();
public static interface ColorSelectorCallback {
public void onColorRollover(Color color);
public void onColorSelected(Color color);
}
public JColorSelectorPopupMenu(ColorSelectorCallback colorSelectorCallback) {
this.colorSelectorCallback = colorSelectorCallback;
}
public void addColorSectionWithDerived(String label, Color[] primaryColors) {
if ((primaryColors == null) || (primaryColors.length != 10)) {
throw new IllegalArgumentException("Must pass exactly 10 colors");
}
JPanel selectorContainer = new MultiRowSelector(primaryColors);
JColorSelectorPanel selector = new JColorSelectorPanel(label,
selectorContainer);
this.addMenuPanel(selector);
this.lastColorSelectorPanel = selector;
}
public void addColorSection(String label, Color[] primaryColors) {
if ((primaryColors == null) || (primaryColors.length != 10)) {
throw new IllegalArgumentException("Must pass exactly 10 colors");
}
JPanel selectorContainer = new SingleRowSelector(primaryColors);
JColorSelectorPanel selector = new JColorSelectorPanel(label,
selectorContainer);
this.addMenuPanel(selector);
this.lastColorSelectorPanel = selector;
}
public void addRecentSection(String label) {
JPanel recent = new SingleRowSelector(recentlySelected
.toArray(new Color[0]));
JColorSelectorPanel recentPanel = new JColorSelectorPanel(label, recent);
recentPanel.setLastPanel(true);
this.addMenuPanel(recentPanel);
this.lastColorSelectorPanel = recentPanel;
}
@Override
public void addMenuButton(JCommandMenuButton menuButton) {
super.addMenuButton(menuButton);
this.updateLastColorSelectorPanel();
}
@Override
public void addMenuButton(JCommandToggleMenuButton menuButton) {
super.addMenuButton(menuButton);
this.updateLastColorSelectorPanel();
}
@Override
public void addMenuSeparator() {
super.addMenuSeparator();
this.updateLastColorSelectorPanel();
}
private void updateLastColorSelectorPanel() {
if (this.lastColorSelectorPanel != null) {
this.lastColorSelectorPanel.setLastPanel(true);
this.lastColorSelectorPanel = null;
}
}
public ColorSelectorCallback getColorSelectorCallback() {
return this.colorSelectorCallback;
}
private static void wireToLRU(JColorSelectorComponent colorSelector) {
colorSelector
.addColorSelectorCallback(new JColorSelectorPopupMenu.ColorSelectorCallback() {
@Override
public void onColorSelected(Color color) {
addColorToRecentlyUsed(color);
}
@Override
public void onColorRollover(Color color) {
}
});
}
public synchronized static List getRecentlyUsedColors() {
return Collections.unmodifiableList(recentlySelected);
}
public synchronized static void addColorToRecentlyUsed(Color color) {
// is in?
if (recentlySelected.contains(color)) {
recentlySelected.remove(color);
recentlySelected.addLast(color);
return;
}
if (recentlySelected.size() == 10) {
recentlySelected.removeFirst();
}
recentlySelected.addLast(color);
}
private class SingleRowSelector extends JPanel {
public SingleRowSelector(final Color... colors) {
final JColorSelectorComponent[] comps = new JColorSelectorComponent[colors.length];
for (int i = 0; i < colors.length; i++) {
comps[i] = new JColorSelectorComponent(colors[i],
colorSelectorCallback);
wireToLRU(comps[i]);
this.add(comps[i]);
}
this.setLayout(new LayoutManager() {
@Override
public void addLayoutComponent(String name, Component comp) {
}
@Override
public void removeLayoutComponent(Component comp) {
}
@Override
public Dimension minimumLayoutSize(Container parent) {
return new Dimension(10, 10);
}
@Override
public Dimension preferredLayoutSize(Container parent) {
int gap = getGap();
int size = getSize();
return new Dimension(colors.length * size
+ (colors.length + 1) * gap, size + 2 * gap);
}
@Override
public void layoutContainer(Container parent) {
int gap = getGap();
int size = getSize();
if (parent.getComponentOrientation().isLeftToRight()) {
int x = gap;
int y = gap;
for (int i = 0; i < colors.length; i++) {
comps[i].setBounds(x, y, size, size);
x += (size + gap);
}
} else {
int x = getWidth() - gap;
int y = gap;
for (int i = 0; i < colors.length; i++) {
comps[i].setBounds(x - size, y, size, size);
x -= (size + gap);
}
}
}
private int getGap() {
return 4;
}
private int getSize() {
return 13;
}
});
}
}
private class MultiRowSelector extends JPanel {
static final int SECONDARY_ROWS = 5;
public MultiRowSelector(final Color... colors) {
final JColorSelectorComponent[][] comps = new JColorSelectorComponent[colors.length][1 + SECONDARY_ROWS];
for (int i = 0; i < colors.length; i++) {
Color primary = colors[i];
comps[i][0] = new JColorSelectorComponent(primary,
colorSelectorCallback);
wireToLRU(comps[i][0]);
this.add(comps[i][0]);
float[] primaryHsb = new float[3];
Color.RGBtoHSB(primary.getRed(), primary.getGreen(), primary
.getBlue(), primaryHsb);
for (int row = 1; row <= SECONDARY_ROWS; row++) {
float bFactor = (float) (row - 1)
/ (float) (SECONDARY_ROWS);
bFactor = (float) Math.pow(bFactor, 1.4f);
float brightness = 1.0f - bFactor;
if (primaryHsb[1] == 0.0f) {
// special handling for gray scale
float max = 0.5f + 0.5f * primaryHsb[2];
brightness = max * (SECONDARY_ROWS - row + 1)
/ SECONDARY_ROWS;
}
Color secondary = new Color(Color.HSBtoRGB(primaryHsb[0],
primaryHsb[1] * (row + 1) / (SECONDARY_ROWS + 1),
brightness));
comps[i][row] = new JColorSelectorComponent(secondary,
colorSelectorCallback);
comps[i][row].setTopOpen(row > 1);
comps[i][row].setBottomOpen(row < SECONDARY_ROWS);
wireToLRU(comps[i][row]);
this.add(comps[i][row]);
}
}
this.setLayout(new LayoutManager() {
@Override
public void addLayoutComponent(String name, Component comp) {
}
@Override
public void removeLayoutComponent(Component comp) {
}
@Override
public Dimension minimumLayoutSize(Container parent) {
return new Dimension(10, 10);
}
@Override
public Dimension preferredLayoutSize(Container parent) {
int gap = getGap();
int size = getSize();
return new Dimension(colors.length * size
+ (colors.length + 1) * gap, gap + size + gap
+ SECONDARY_ROWS * size + gap);
}
@Override
public void layoutContainer(Container parent) {
int gap = getGap();
int size = getSize();
if (parent.getComponentOrientation().isLeftToRight()) {
int y = gap;
for (int row = 0; row <= SECONDARY_ROWS; row++) {
int x = gap;
for (int i = 0; i < colors.length; i++) {
comps[i][row].setBounds(x, y, size, size);
x += (size + gap);
}
y += size;
if (row == 0) {
y += gap;
}
}
} else {
int y = gap;
for (int row = 0; row <= SECONDARY_ROWS; row++) {
int x = getWidth() - gap;
for (int i = 0; i < colors.length; i++) {
comps[i][row]
.setBounds(x - size, y, size, size);
x -= (size + gap);
}
y += size;
if (row == 0) {
y += gap;
}
}
}
}
private int getGap() {
return 4;
}
private int getSize() {
return 13;
}
});
}
}
}
src/org/pushingpixels/flamingo/api/common/popup/JCommandPopupMenu.java 0000644 0001750 0001750 00000026502 11421613102 025302 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.popup;
import java.awt.Component;
import java.util.ArrayList;
import java.util.Collections;
import javax.swing.*;
import javax.swing.JPopupMenu.Separator;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.pushingpixels.flamingo.api.common.*;
import org.pushingpixels.flamingo.internal.ui.common.popup.BasicCommandPopupMenuUI;
import org.pushingpixels.flamingo.internal.ui.common.popup.PopupPanelUI;
/**
* Popup menu. Can host any number of command menu buttons added with
* {@link #addMenuButton(JCommandMenuButton)} separated with optional
* {@link #addMenuSeparator()}. The
* {@link #JCommandPopupMenu(JCommandButtonPanel, int, int)} constructor allows
* placing a scrollable command button panel in the top part of the popup menu.
*
* @author Kirill Grouchnikov
*/
public class JCommandPopupMenu extends JPopupPanel {
/**
* @see #getUIClassID
*/
public static final String uiClassID = "CommandPopupMenuUI";
/**
* The main button panel. Can be null if this command popup
* menu was created with the {@link #JCommandPopupMenu()} constructor.
*
* @see #JCommandPopupMenu(JCommandButtonPanel, int, int)
* @see #hasCommandButtonPanel()
* @see #getMainButtonPanel()
*/
protected JCommandButtonPanel mainButtonPanel;
/**
* Menu components. This list holds:
*
* - {@link JCommandMenuButton}s added with
* {@link #addMenuButton(JCommandMenuButton)}
* - {@link JCommandToggleMenuButton}s added with
* {@link #addMenuButton(JCommandToggleMenuButton)}
* - {@link Separator}s added with {@link #addMenuSeparator()}
* - {@link JPanel}s added by the subclasses with
* {@link #addMenuPanel(JPanel)}
*
*
* @see #addMenuButton(JCommandMenuButton)
* @see #addMenuButton(JCommandToggleMenuButton)
* @see #addMenuSeparator()
* @see #addMenuPanel(JPanel)
* @see #getMenuComponents()
*/
protected java.util.List menuComponents;
/**
* Maximum number of button columns visible in the {@link #mainButtonPanel}.
*
* @see #JCommandPopupMenu(JCommandButtonPanel, int, int)
* @see #getMaxButtonColumns()
*/
protected int maxButtonColumns;
/**
* Maximum number of button rows visible in the {@link #mainButtonPanel}.
*
* @see #JCommandPopupMenu(JCommandButtonPanel, int, int)
* @see #getMaxVisibleButtonRows()
*/
protected int maxVisibleButtonRows;
/**
* Maximum number of menu items visible in this menu. If more buttons are
* added with the {@link #addMenuButton(JCommandMenuButton)} and
* {@link #addMenuButton(JCommandToggleMenuButton)} APIs, the menu part will
* show scroller buttons above the first and below the last menu button. If
* the value is negative, there is no limitation on how many menu buttons
* are shown, and the entire popup menu can overflow the monitor edges.
*/
protected int maxVisibleMenuButtons;
private boolean toDismissOnChildClick;
/**
* Creates an empty popup menu with no button panel.
*/
public JCommandPopupMenu() {
this.menuComponents = new ArrayList();
this.maxVisibleMenuButtons = -1;
this.toDismissOnChildClick = true;
}
/**
* Creates a popup menu hosting the specified button panel.
*
* @param buttonPanel
* Fully constructed button panel.
* @param maxButtonColumns
* Maximum number of button columns visible in
* buttonPanel.
* @param maxVisibleButtonRows
* Maximum number of button rows visible in
* buttonPanel.
*/
public JCommandPopupMenu(JCommandButtonPanel buttonPanel,
int maxButtonColumns, int maxVisibleButtonRows) {
this();
this.mainButtonPanel = buttonPanel;
this.maxButtonColumns = maxButtonColumns;
this.maxVisibleButtonRows = maxVisibleButtonRows;
this.updateUI();
}
/**
* Adds the specified menu button to this menu.
*
* @param menuButton
* Menu button to add.
*/
public void addMenuButton(JCommandMenuButton menuButton) {
menuButton.setHorizontalAlignment(SwingUtilities.LEFT);
this.menuComponents.add(menuButton);
this.fireStateChanged();
}
/**
* Adds the specified toggle menu button to this menu.
*
* @param menuButton
* Menu button to add.
*/
public void addMenuButton(JCommandToggleMenuButton menuButton) {
menuButton.setHorizontalAlignment(SwingUtilities.LEFT);
this.menuComponents.add(menuButton);
this.fireStateChanged();
}
/**
* Adds a menu separator to this menu.
*/
public void addMenuSeparator() {
this.menuComponents.add(new JPopupMenu.Separator());
this.fireStateChanged();
}
/**
* Adds a menu panel to this menu.
*
* @param menuPanel
* Menu panel to add.
*/
protected void addMenuPanel(JPanel menuPanel) {
if (this.maxVisibleMenuButtons > 0) {
throw new IllegalStateException(
"This method is not supported on menu that contains a command button panel");
}
this.menuComponents.add(menuPanel);
this.fireStateChanged();
}
/**
* Returns indication whether this menu has a command button panel.
*
* @return true if this menu has a command button panel,
* false otherwise.
* @see #getMainButtonPanel()
*/
public boolean hasCommandButtonPanel() {
return (this.mainButtonPanel != null);
}
/**
* Returns the command button panel of this menu. Can return
* null.
*
* @return The command button panel of this menu.
* @see #hasCommandButtonPanel()
*/
public JCommandButtonPanel getMainButtonPanel() {
return this.mainButtonPanel;
}
/**
* Returns an unmodifiable list of all the menu components. Can return
* null.
*
* @return An unmodifiable list of all the menu components
*/
public java.util.List getMenuComponents() {
if (this.menuComponents == null)
return null;
return Collections.unmodifiableList(this.menuComponents);
}
/**
* Returns the maximum number of button columns visible in the command
* button panel of this menu. If this menu has been created with the
* {@link #JCommandPopupMenu()} constructor, zero is returned.
*
* @return The maximum number of button columns visible in the command
* button panel of this menu.
* @see #JCommandPopupMenu(JCommandButtonPanel, int, int)
* @see #getMaxVisibleButtonRows()
*/
public int getMaxButtonColumns() {
return this.maxButtonColumns;
}
/**
* Returns the maximum number of button rows visible in the command button
* panel of this menu. If this menu has been created with the
* {@link #JCommandPopupMenu()} constructor, zero is returned.
*
* @return The maximum number of button rows visible in the command button
* panel of this menu.
* @see #JCommandPopupMenu(JCommandButtonPanel, int, int)
* @see #getMaxButtonColumns()
*/
public int getMaxVisibleButtonRows() {
return this.maxVisibleButtonRows;
}
/**
* Returns the maximum number of menu items visible in this menu.
*
* @return The maximum number of menu items visible in this menu. If the
* value is negative, there is no limitation on how many menu
* buttons are shown, and the entire popup menu can overflow the
* monitor edges.
*/
public int getMaxVisibleMenuButtons() {
return this.maxVisibleMenuButtons;
}
/**
* Sets the maximum number of menu items visible in this menu. If the value
* is negative, there is no limitation on how many menu buttons are shown,
* and the entire popup menu can overflow the monitor edges.
*
* @param maxVisibleMenuButtons
* The new value for the maximum number of menu items visible in
* this menu.
*/
public void setMaxVisibleMenuButtons(int maxVisibleMenuButtons) {
for (Component menuComp : this.menuComponents) {
if (menuComp instanceof JPanel) {
throw new IllegalStateException(
"This method is not supported on menus with panels");
}
}
int old = this.maxVisibleMenuButtons;
this.maxVisibleMenuButtons = maxVisibleMenuButtons;
if (old != this.maxVisibleMenuButtons) {
this.firePropertyChange("maxVisibleMenuButtons", old,
this.maxVisibleMenuButtons);
}
}
@Override
public String getUIClassID() {
return uiClassID;
}
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((PopupPanelUI) UIManager.getUI(this));
} else {
setUI(BasicCommandPopupMenuUI.createUI(this));
}
}
/**
* Adds the specified change listener to track changes to this popup menu.
*
* @param l
* Change listener to add.
* @see #removeChangeListener(ChangeListener)
*/
public void addChangeListener(ChangeListener l) {
this.listenerList.add(ChangeListener.class, l);
}
/**
* Removes the specified change listener from tracking changes to this popup
* menu.
*
* @param l
* Change listener to remove.
* @see #addChangeListener(ChangeListener)
*/
public void removeChangeListener(ChangeListener l) {
this.listenerList.remove(ChangeListener.class, l);
}
/**
* Notifies all registered listener that the state of this popup menu has
* changed.
*/
protected void fireStateChanged() {
// Guaranteed to return a non-null array
Object[] listeners = this.listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
ChangeEvent event = new ChangeEvent(this);
for (int i = listeners.length - 2; i >= 0; i -= 2) {
if (listeners[i] == ChangeListener.class) {
((ChangeListener) listeners[i + 1]).stateChanged(event);
}
}
}
public boolean isToDismissOnChildClick() {
return toDismissOnChildClick;
}
public void setToDismissOnChildClick(boolean toDismissOnChildClick) {
this.toDismissOnChildClick = toDismissOnChildClick;
}
}
src/org/pushingpixels/flamingo/api/common/popup/PopupPanelCallback.java 0000644 0001750 0001750 00000004765 11401230444 025452 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.popup;
import org.pushingpixels.flamingo.api.common.JCommandButton;
import org.pushingpixels.flamingo.api.ribbon.RibbonApplicationMenuEntrySecondary;
/**
* An application hook that allows associating a custom popup panel with a popup
* area of the specific command button.
*
* @author Kirill Grouchnikov
* @see JCommandButton#setPopupCallback(PopupPanelCallback)
* @see RibbonApplicationMenuEntrySecondary#setPopupCallback(PopupPanelCallback)
*/
public interface PopupPanelCallback {
/**
* Returns the popup panel to be shown when the popup area of the specified
* command button is activated.
*
* @param commandButton
* Command button.
* @return The popup panel to be shown when the popup area of the specified
* command button is activated.
*/
public JPopupPanel getPopupPanel(JCommandButton commandButton);
}
src/org/pushingpixels/flamingo/api/common/popup/JPopupPanel.java 0000644 0001750 0001750 00000010232 11421612346 024140 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.popup;
import java.awt.Rectangle;
import javax.swing.JPanel;
import javax.swing.UIManager;
import org.pushingpixels.flamingo.internal.ui.common.popup.BasicPopupPanelUI;
import org.pushingpixels.flamingo.internal.ui.common.popup.PopupPanelUI;
/**
* Base class for popup panels.
*
* @author Kirill Grouchnikov
* @see PopupPanelManager#addPopup(javax.swing.JComponent, javax.swing.Popup,
* JPopupPanel)
*/
public abstract class JPopupPanel extends JPanel {
/**
* @see #getUIClassID
*/
public static final String uiClassID = "PopupPanelUI";
/**
* The customizer for this popup panel. Can be null.
*
* @see #getCustomizer()
* @see #setCustomizer(PopupPanelCustomizer)
*/
protected PopupPanelCustomizer customizer;
/**
* Allows providing custom application logic for computing the screen bounds
* of popup panels before they are shown on the screen.
*
* @author Kirill Grouchnikov
*/
public static interface PopupPanelCustomizer {
/**
* Returns the requested screen bounds of the associated popup panel.
*
* @return The requested screen bounds of the associated popup panel.
*/
public Rectangle getScreenBounds();
}
/**
* Protected to prevent direct instantiation.
*/
protected JPopupPanel() {
}
/*
* (non-Javadoc)
*
* @see javax.swing.JPanel#getUI()
*/
@Override
public PopupPanelUI getUI() {
return (PopupPanelUI) ui;
}
/**
* Sets the look and feel (L&F) object that renders this component.
*
* @param ui
* the PopupGalleryUI L&F object
*/
protected void setUI(PopupPanelUI ui) {
super.setUI(ui);
}
/*
* (non-Javadoc)
*
* @see javax.swing.JPanel#getUIClassID()
*/
@Override
public String getUIClassID() {
return uiClassID;
}
/*
* (non-Javadoc)
*
* @see javax.swing.JPanel#updateUI()
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((PopupPanelUI) UIManager.getUI(this));
} else {
setUI(BasicPopupPanelUI.createUI(this));
}
}
/**
* Sets the customizer for this popup panel.
*
* @param customizer
* The customizer for this popup panel.
* @see #getCustomizer()
*/
public void setCustomizer(PopupPanelCustomizer customizer) {
this.customizer = customizer;
}
/**
* Returns the customizer of this popup panel. Can return null.
*
* @return The customizer of this popup panel.
* @see #setCustomizer(PopupPanelCustomizer)
*/
public PopupPanelCustomizer getCustomizer() {
return this.customizer;
}
}
src/org/pushingpixels/flamingo/api/common/popup/PopupPanelManager.java 0000644 0001750 0001750 00000024413 11401230444 025320 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.popup;
import java.awt.Component;
import java.awt.event.ComponentEvent;
import java.util.*;
import javax.swing.JComponent;
import javax.swing.Popup;
import javax.swing.event.EventListenerList;
import org.pushingpixels.flamingo.api.common.JCommandButton;
/**
* Manager for showing and hiding {@link JPopupPanel}s.
*
* @author Kirill Grouchnikov
*/
public class PopupPanelManager {
/**
* Listener on showing and hiding the popup panels.
*
* @author Kirill Grouchnikov
*/
public static interface PopupListener extends EventListener {
/**
* Fired when a popup panel has been shown.
*
* @param event
* Popup event.
*/
void popupShown(PopupEvent event);
/**
* Fired when a popup panel has been hidden.
*
* @param event
* Popup event.
*/
void popupHidden(PopupEvent event);
}
/**
* Popup event.
*
* @author Kirill Grouchnikov
*/
public static class PopupEvent extends ComponentEvent {
/**
* ID of "popup shown" event.
*/
public static final int POPUP_SHOWN = 100;
/**
* ID of "popup hidden" event.
*/
public static final int POPUP_HIDDEN = 101;
/**
* The popup originator component.
*/
private JComponent popupOriginator;
/**
* Creates a new popup event.
*
* @param source
* Event source.
* @param id
* Event ID.
* @param popupOriginator
* Popup originator component.
*/
public PopupEvent(JPopupPanel source, int id, JComponent popupOriginator) {
super(source, id);
this.popupOriginator = popupOriginator;
}
/**
* Returns the popup originator component.
*
* @return Popup originator component.
*/
public JComponent getPopupOriginator() {
return this.popupOriginator;
}
}
/**
* List of all registered listeners.
*/
protected EventListenerList listenerList = new EventListenerList();
/**
* The singleton instance of popup panel manager.
*/
private static final PopupPanelManager instance = new PopupPanelManager();
/**
* Information on a single showing popup.
*
* @author Kirill Grouchnikov
*/
public static class PopupInfo {
/**
* The popup panel.
*/
private JPopupPanel popupPanel;
/**
* The originating component.
*/
private JComponent popupOriginator;
/**
* Creates a new information object.
*
* @param popupOriginator
* The originating component.
* @param popupPanel
* The popup panel.
*/
public PopupInfo(JComponent popupOriginator, JPopupPanel popupPanel) {
this.popupOriginator = popupOriginator;
this.popupPanel = popupPanel;
}
/**
* Returns the popup panel.
*
* @return The popup panel.
*/
public JPopupPanel getPopupPanel() {
return this.popupPanel;
}
/**
* Returns the originating component.
*
* @return The originating component.
*/
public JComponent getPopupOriginator() {
return this.popupOriginator;
}
}
/**
* Returns the default popup panel manager.
*
* @return a PopupPanelManager object
*/
public static PopupPanelManager defaultManager() {
return instance;
}
/**
* All currently shown popup panels.
*/
protected LinkedList shownPath = new LinkedList();
/**
* Map of all popup panels and associated {@link Popup} objects.
*/
protected Map popupPanels = new HashMap();
/**
* Adds new popup to the tracking structures.
*
* @param popupOriginator
* The originating component.
* @param popup
* The new popup.
* @param popupInitiator
* The initiator of the popup.
*/
public void addPopup(JComponent popupOriginator, Popup popup,
JPopupPanel popupInitiator) {
popupPanels.put(popupInitiator, popup);
shownPath.addLast(new PopupInfo(popupOriginator, popupInitiator));
popup.show();
if (popupOriginator instanceof JCommandButton) {
((JCommandButton) popupOriginator).getPopupModel().setPopupShowing(
true);
}
this.firePopupShown(popupInitiator, popupOriginator);
}
/**
* Hides the last shown popup panel.
*/
public void hideLastPopup() {
if (shownPath.size() == 0)
return;
PopupInfo last = shownPath.removeLast();
Popup popup = popupPanels.get(last.popupPanel);
popup.hide();
popupPanels.remove(last.popupPanel);
if (last.popupOriginator instanceof JCommandButton) {
((JCommandButton) last.popupOriginator).getPopupModel()
.setPopupShowing(false);
}
// KeyTipManager.defaultManager().showChainBefore(last.popupPanel);
this.firePopupHidden(last.popupPanel, last.popupOriginator);
}
/**
* Hides all popup panels based on the specified component. We find the
* first ancestor of the specified component that is popup panel, and close
* all popup panels that were open from that popup panel. If the specified
* component is null, all popup panels are closed.
*
* @param comp
* Component.
*/
public void hidePopups(Component comp) {
// System.out.println("Hiding all popups");
// try {
// throw new Exception();
// }
// catch (Exception exc) {
// exc.printStackTrace(System.out);
// System.out.println("At " + System.currentTimeMillis() + "\n");
// }
boolean foundAndDismissed = false;
if (comp != null) {
Component c = comp;
// find JPopupGallery parent of the component
while (c != null) {
if (c instanceof JPopupPanel) {
foundAndDismissed = true;
// And close all popups that were opened
// from the found popup panel
while (shownPath.size() > 0) {
if (shownPath.getLast().popupPanel == c)
return;
PopupInfo last = shownPath.removeLast();
Popup popup = popupPanels.get(last.popupPanel);
popup.hide();
if (last.popupOriginator instanceof JCommandButton) {
((JCommandButton) last.popupOriginator)
.getPopupModel().setPopupShowing(false);
}
this.firePopupHidden(last.popupPanel,
last.popupOriginator);
popupPanels.remove(last.popupPanel);
}
}
c = c.getParent();
}
}
if (!foundAndDismissed || (comp == null)) {
while (shownPath.size() > 0) {
PopupInfo last = shownPath.removeLast();
Popup popup = popupPanels.get(last.popupPanel);
popup.hide();
if (last.popupOriginator instanceof JCommandButton) {
((JCommandButton) last.popupOriginator).getPopupModel()
.setPopupShowing(false);
}
this.firePopupHidden(last.popupPanel, last.popupOriginator);
popupPanels.remove(last.popupPanel);
}
}
}
/**
* Returns all currently shown popup panels.
*
* @return All currently shown popup panels.
*/
public List getShownPath() {
List toReturn = new ArrayList();
for (PopupInfo pInfo : this.shownPath)
toReturn.add(pInfo);
return toReturn;
}
/**
* Adds the specified popup listener.
*
* @param l
* Listener to add.
*/
public void addPopupListener(PopupListener l) {
this.listenerList.add(PopupListener.class, l);
}
/**
* Removes the specified popup listener.
*
* @param l
* Listener to remove.
*/
public void removePopupListener(PopupListener l) {
this.listenerList.remove(PopupListener.class, l);
}
/**
* Fires an event on showing the specified popup panel.
*
* @param panel
* Popup panel that was shown.
* @param popupOriginator
* The originating component.
*/
protected void firePopupShown(JPopupPanel panel, JComponent popupOriginator) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
PopupEvent popupEvent = new PopupEvent(panel, PopupEvent.POPUP_SHOWN,
popupOriginator);
// 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] == PopupListener.class) {
((PopupListener) listeners[i + 1]).popupShown(popupEvent);
}
}
}
/**
* Fires an event on hiding the specified popup panel.
*
* @param panel
* Popup panel that was hidden.
* @param popupOriginator
* The originating component.
*/
protected void firePopupHidden(JPopupPanel panel, JComponent popupOriginator) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
PopupEvent popupEvent = new PopupEvent(panel, PopupEvent.POPUP_HIDDEN,
popupOriginator);
// 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] == PopupListener.class) {
((PopupListener) listeners[i + 1]).popupHidden(popupEvent);
}
}
}
}
src/org/pushingpixels/flamingo/api/common/AsynchronousLoadListener.java 0000644 0001750 0001750 00000004710 11401230444 025576 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.util.EventListener;
import java.util.concurrent.ExecutorService;
import org.pushingpixels.flamingo.api.svg.SvgBatikResizableIcon;
/**
* This interface is used for asynchronously-loaded contents. For example, the
* {@link SvgBatikResizableIcon} uses the {@link ExecutorService} to load the
* SVG image in the background. When the image is loaded, the component that
* contains this image ({@link JCommandButton} for example) is notified to
* repaint itself.
*
* @author Kirill Grouchnikov.
*/
public interface AsynchronousLoadListener extends EventListener {
/**
* Indicates that the asynchronous load has been completed.
*
* @param success
* If true, the load has been completed
* successfully.
*/
public void completed(boolean success);
}
src/org/pushingpixels/flamingo/api/common/CommandButtonLayoutManager.java 0000644 0001750 0001750 00000012654 11401230444 026046 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.*;
import java.beans.PropertyChangeListener;
import java.util.List;
/**
* Definition of a layout manager for {@link AbstractCommandButton}s.
*
* @author Kirill Grouchnikov
*/
public interface CommandButtonLayoutManager extends PropertyChangeListener {
/**
* Enumerates the available values for separator orientations.
*
* @author Kirill Grouchnikov
*/
public enum CommandButtonSeparatorOrientation {
/**
* Vertical separator orientation.
*/
VERTICAL,
/**
* Horizontal separator orientation.
*/
HORIZONTAL
}
/**
* Layout information on a single line of text.
*
* @author Kirill Grouchnikov
*/
public class TextLayoutInfo {
/**
* Text itself.
*/
public String text;
/**
* The text rectangle.
*/
public Rectangle textRect;
}
/**
* Layout information on different visual parts of a single command button.
*
* @author Kirill Grouchnikov
*/
public class CommandButtonLayoutInfo {
/**
* The action area. A mouse click in this area will trigger all
* listeners associated with the command button action model
* {@link AbstractCommandButton#addActionListener(java.awt.event.ActionListener)}
*/
public Rectangle actionClickArea;
/**
* The popup area. A mouse click in this area will trigger the listener
* associated with the command button popup model
* {@link JCommandButton#setPopupCallback(org.jvnet.flamingo.common.popup.PopupPanelCallback)}
*/
public Rectangle popupClickArea;
/**
* The separator area. If it's not empty, the command button will show a
* separator between {@link #actionClickArea} and
* {@link #popupClickArea} on mouse rollover - depending on the current
* look-and-feel.
*/
public Rectangle separatorArea;
public CommandButtonSeparatorOrientation separatorOrientation;
/**
* Rectangle for the command button icon.
*/
public Rectangle iconRect;
/**
* Layout information for the command button text (that can span
* multiple lines).
*/
public List textLayoutInfoList;
/**
* Layout information for the command button extra text (that can span
* multiple lines).
*/
public List extraTextLayoutInfoList;
/**
* Rectangle for the icon associated with the {@link #popupClickArea}.
* This icon is usually a single or double arrow indicating that the
* command button has a popup area.
*/
public Rectangle popupActionRect;
/**
* Indication whether the command button text (rectangles in
* {@link #textLayoutInfoList}) belongs in the action area.
*/
public boolean isTextInActionArea;
}
/**
* Returns the preferred size of the specified command button.
*
* @param commandButton
* Command button.
* @return The preferred size of the specified command button.
*/
public Dimension getPreferredSize(AbstractCommandButton commandButton);
/**
* Returns the preferred icon size of command buttons which use this layout
* manager.
*
* @return The preferred icon size of command buttons which use this layout
* manager.
*/
public int getPreferredIconSize();
/**
* Returns the anchor center point of the key tip of the specified command
* button.
*
* @param commandButton
* Command button.
* @return The anchor center point of the key tip of the specified command
* button.
*/
public Point getKeyTipAnchorCenterPoint(AbstractCommandButton commandButton);
/**
* Returns the layout information for the specified command button.
*
* @param commandButton
* Command button.
* @param g
* Graphics context.
* @return The layout information for the specified command button.
*/
public CommandButtonLayoutInfo getLayoutInfo(
AbstractCommandButton commandButton, Graphics g);
}
src/org/pushingpixels/flamingo/api/common/JCommandToggleButton.java 0000644 0001750 0001750 00000007025 11401230444 024625 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import javax.swing.JComponent;
import javax.swing.UIManager;
import org.pushingpixels.flamingo.api.common.icon.ResizableIcon;
import org.pushingpixels.flamingo.api.common.model.ActionToggleButtonModel;
import org.pushingpixels.flamingo.internal.ui.common.BasicCommandToggleButtonUI;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI;
/**
* Command button.
*
* @author Kirill Grouchnikov
*/
public class JCommandToggleButton extends AbstractCommandButton {
/**
* The UI class ID string.
*/
public static final String uiClassID = "CommandToggleButtonUI";
/**
* Creates a new command toggle button with empty text
*
* @param icon
* Button icon.
*/
public JCommandToggleButton(ResizableIcon icon) {
this(null, icon);
}
/**
* Creates a new command toggle button without an icon.
*
* @param title
* Button title. May contain any number of words.
*/
public JCommandToggleButton(String title) {
this(title, null);
}
/**
* Creates a new command toggle button.
*
* @param title
* Button title. May contain any number of words.
* @param icon
* Button icon.
*/
public JCommandToggleButton(String title, ResizableIcon icon) {
super(title, icon);
this.setActionModel(new ActionToggleButtonModel(false));
this.updateUI();
}
/**
* Resets the UI property to a value from the current look and feel.
*
* @see JComponent#updateUI
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((CommandButtonUI) UIManager.getUI(this));
} else {
setUI(BasicCommandToggleButtonUI.createUI(this));
}
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#getUIClassID()
*/
@Override
public String getUIClassID() {
return uiClassID;
}
@Override
public String toString() {
return "Command toggle button[" + this.getText() + "]";
}
}
src/org/pushingpixels/flamingo/api/common/JCommandButton.java 0000644 0001750 0001750 00000061170 11401230444 023464 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.*;
import org.pushingpixels.flamingo.api.common.icon.ResizableIcon;
import org.pushingpixels.flamingo.api.common.model.ActionRepeatableButtonModel;
import org.pushingpixels.flamingo.api.common.model.PopupButtonModel;
import org.pushingpixels.flamingo.api.common.popup.PopupPanelCallback;
import org.pushingpixels.flamingo.internal.ui.common.BasicCommandButtonUI;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI;
/**
* Command button.
*
* @author Kirill Grouchnikov
*/
public class JCommandButton extends AbstractCommandButton {
/**
* The UI class ID string.
*/
public static final String uiClassID = "CommandButtonUI";
/**
* Associated popup callback. May be null.
*
* @see #setPopupCallback(PopupPanelCallback)
* @see #getPopupCallback()
*/
protected PopupPanelCallback popupCallback;
/**
* The command button kind of this button.
*
* @see #setCommandButtonKind(CommandButtonKind)
* @see #getCommandButtonKind()
*/
protected CommandButtonKind commandButtonKind;
/**
* The popup orientation kind of this button.
*
* @see #setPopupOrientationKind(CommandButtonPopupOrientationKind)
* @see #getPopupOrientationKind()
*/
protected CommandButtonPopupOrientationKind popupOrientationKind;
/**
* Indicates the auto-repeat action mode. When the button is not in the
* auto-repeat action mode, the registered action listeners are activated
* when the mouse is released (just as with the base {@link AbstractButton}
* ). When the button is in auto-repeat mode, the registered action
* listeners are activated when the mouse is pressed. In addition, if the
* mouse is still pressed after {@link #getAutoRepeatInitialInterval()}, the
* action listeners will be activated every
* {@link #getAutoRepeatSubsequentInterval()} until the button is disabled
* or the mouse is released.
*
* @see #autoRepeatInitialInterval
* @see #autoRepeatSubsequentInterval
* @see #setAutoRepeatAction(boolean)
* @see #isAutoRepeatAction()
*/
protected boolean isAutoRepeatAction;
/**
* The initial interval for invoking the registered action listeners in the
* auto-repeat action mode.
*
* @see #isAutoRepeatAction
* @see #autoRepeatSubsequentInterval
* @see #getAutoRepeatInitialInterval()
* @see #setAutoRepeatActionIntervals(int, int)
*/
protected int autoRepeatInitialInterval;
/**
* The subsequent interval for invoking the registered action listeners in
* the auto-repeat action mode.
*
* @see #isAutoRepeatAction
* @see #autoRepeatInitialInterval
* @see #getAutoRepeatSubsequentInterval()
* @see #setAutoRepeatActionIntervals(int, int)
*/
protected int autoRepeatSubsequentInterval;
/**
* Indicates that rollover should result in firing the action. Used in
* conjunction with the {@link #isAutoRepeatAction} can model quick pan
* buttons such as breadcrumb bar scrollers.
*
* @see #setFireActionOnRollover(boolean)
* @see #isFireActionOnRollover()
*/
protected boolean isFireActionOnRollover;
/**
* Popup model of this button.
*
* @see #setPopupModel(PopupButtonModel)
* @see #getPopupModel()
*/
protected PopupButtonModel popupModel;
/**
* Default popup handler for this button.
*/
protected PopupHandler popupHandler;
/**
* Rich tooltip for the popup area of this button.
*
* @see #setPopupRichTooltip(RichTooltip)
* @see #getRichTooltip(MouseEvent)
*/
private RichTooltip popupRichTooltip;
/**
* Key tip for the popup area of this button.
*
* @see #setPopupKeyTip(String)
* @see #getPopupKeyTip()
*/
protected String popupKeyTip;
/**
* Enumerates the available command button kinds.
*
* @author Kirill Grouchnikov
*/
public static enum CommandButtonKind {
/**
* Command button that has only action area.
*/
ACTION_ONLY(true, false),
/**
* Command button that has only popup area.
*/
POPUP_ONLY(false, true),
/**
* Command button that has both action and popup areas, with the main
* text click activating the action.
*/
ACTION_AND_POPUP_MAIN_ACTION(true, true),
/**
* Command button that has both action and popup areas, with the main
* text click activating the popup.
*/
ACTION_AND_POPUP_MAIN_POPUP(true, true);
/**
* true if the command button kind has an action.
*/
private boolean hasAction;
/**
* true if the command button kind has a popup.
*/
private boolean hasPopup;
/**
* Constructs a new command button kind.
*
* @param hasAction
* Indicates whether the command button kind has an action.
* @param hasPopup
* Indicates whether the command button kind has a popup.
*/
private CommandButtonKind(boolean hasAction, boolean hasPopup) {
this.hasAction = hasAction;
this.hasPopup = hasPopup;
}
/**
* Returns indication whether this command button kind has an action.
*
* @return true if the command button kind has an action,
* false otherwise.
*/
public boolean hasAction() {
return hasAction;
}
/**
* Returns indication whether this command button kind has a popup.
*
* @return true if the command button kind has a popup,
* false otherwise.
*/
public boolean hasPopup() {
return hasPopup;
}
}
/**
* Orientation kind for the popup.
*
* @author Kirill Grouchnikov
*/
public static enum CommandButtonPopupOrientationKind {
/**
* Indicates that the popup should be displayed below the button.
*/
DOWNWARD,
/**
* Indicates that the popup should be displayed to the side of the
* button.
*/
SIDEWARD
}
/**
* Extension of the default button model that supports the
* {@link PopupButtonModel} interface.
*
* @author Kirill Grouchnikov
*/
private static class DefaultPopupButtonModel extends DefaultButtonModel
implements PopupButtonModel {
/**
* Timer for the auto-repeat action mode.
*/
protected Timer autoRepeatTimer;
/**
* Identifies the "popup showing" bit in the bitmask, which indicates
* that the visibility status of the associated popup.
*/
public final static int POPUP_SHOWING = 1 << 8;
/**
* Creates a new default popup button model.
*/
public DefaultPopupButtonModel() {
super();
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.PopupButtonModel#addPopupActionListener
* (org.jvnet.flamingo.common.PopupActionListener)
*/
@Override
public void addPopupActionListener(PopupActionListener l) {
listenerList.add(PopupActionListener.class, l);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.PopupButtonModel#removePopupActionListener
* (org.jvnet.flamingo.common.PopupActionListener)
*/
@Override
public void removePopupActionListener(PopupActionListener l) {
listenerList.remove(PopupActionListener.class, l);
}
/**
* Notifies all listeners that have registered interest for notification
* on this event type.
*
* @param e
* the ActionEvent to deliver to listeners
* @see EventListenerList
*/
protected void firePopupActionPerformed(ActionEvent e) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// 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] == PopupActionListener.class) {
((PopupActionListener) listeners[i + 1]).actionPerformed(e);
}
}
}
/*
* (non-Javadoc)
*
* @see javax.swing.DefaultButtonModel#setPressed(boolean)
*/
@Override
public void setPressed(boolean b) {
if ((isPressed() == b) || !isEnabled()) {
return;
}
if (b) {
stateMask |= PRESSED;
} else {
stateMask &= ~PRESSED;
}
if (isPressed() && isArmed()) {
// fire the popup action on button press and not on button
// release - like the comboboxes
int modifiers = 0;
AWTEvent currentEvent = EventQueue.getCurrentEvent();
if (currentEvent instanceof InputEvent) {
modifiers = ((InputEvent) currentEvent).getModifiers();
} else if (currentEvent instanceof ActionEvent) {
modifiers = ((ActionEvent) currentEvent).getModifiers();
}
firePopupActionPerformed(new ActionEvent(this,
ActionEvent.ACTION_PERFORMED, getActionCommand(),
EventQueue.getMostRecentEventTime(), modifiers));
}
fireStateChanged();
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.PopupButtonModel#isPopupShowing()
*/
@Override
public boolean isPopupShowing() {
return (stateMask & POPUP_SHOWING) != 0;
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.PopupButtonModel#setPopupShowing(boolean)
*/
@Override
public void setPopupShowing(boolean b) {
// System.out.println(this.isPopupShowing() + "-->" + b);
if (this.isPopupShowing() == b) {
return;
}
if (b) {
stateMask |= POPUP_SHOWING;
} else {
stateMask &= ~POPUP_SHOWING;
}
fireStateChanged();
}
}
/**
* Creates a new command button with empty text
*
* @param icon
* Button icon.
*/
public JCommandButton(ResizableIcon icon) {
this(null, icon);
}
/**
* Creates a new command button without an icon.
*
* @param title
* Button title. May contain any number of words.
*/
public JCommandButton(String title) {
this(title, null);
}
/**
* Creates a new command button.
*
* @param title
* Button title. May contain any number of words.
* @param icon
* Button icon.
*/
public JCommandButton(String title, ResizableIcon icon) {
super(title, icon);
this.setActionModel(new ActionRepeatableButtonModel(this));
// important - handler creation must be done before setting
// the popup model so that it can be registered to track the
// changes
this.popupHandler = new PopupHandler();
this.setPopupModel(new DefaultPopupButtonModel());
this.commandButtonKind = CommandButtonKind.ACTION_ONLY;
this.popupOrientationKind = CommandButtonPopupOrientationKind.DOWNWARD;
// this.displayState = CommandButtonDisplayState.CUSTOM;
this.isAutoRepeatAction = false;
this.autoRepeatInitialInterval = 500;
this.autoRepeatSubsequentInterval = 100;
this.updateUI();
}
/**
* Returns the command button kind of this button.
*
* @return Command button kind of this button.
* @see #setCommandButtonKind(CommandButtonKind)
*/
public CommandButtonKind getCommandButtonKind() {
return this.commandButtonKind;
}
/**
* Sets the kind for this button. Fires a commandButtonKind
* property change event.
*
* @param commandButtonKind
* The new button kind.
* @see #getCommandButtonKind()
*/
public void setCommandButtonKind(CommandButtonKind commandButtonKind) {
CommandButtonKind old = this.commandButtonKind;
this.commandButtonKind = commandButtonKind;
if (old != this.commandButtonKind) {
firePropertyChange("commandButtonKind", old, this.commandButtonKind);
}
}
/**
* Returns the popup orientation kind of this button.
*
* @return Popup orientation kind of this button.
* @see #setPopupOrientationKind(CommandButtonPopupOrientationKind)
*/
public CommandButtonPopupOrientationKind getPopupOrientationKind() {
return this.popupOrientationKind;
}
/**
* Sets the popup orientation for this button. Fires a
* popupOrientationKind property change event.
*
* @param popupOrientationKind
* The new popup orientation kind.
* @see #getPopupOrientationKind()
*/
public void setPopupOrientationKind(
CommandButtonPopupOrientationKind popupOrientationKind) {
CommandButtonPopupOrientationKind old = this.popupOrientationKind;
this.popupOrientationKind = popupOrientationKind;
if (old != this.popupOrientationKind) {
firePropertyChange("popupOrientationKind", old,
this.popupOrientationKind);
}
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#updateUI()
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((CommandButtonUI) UIManager.getUI(this));
} else {
setUI(BasicCommandButtonUI.createUI(this));
}
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#getUIClassID()
*/
@Override
public String getUIClassID() {
return uiClassID;
}
/**
* Returns the associated popup callback.
*
* @return The associated popup callback.
* @see #setPopupCallback(PopupPanelCallback)
*/
public PopupPanelCallback getPopupCallback() {
return this.popupCallback;
}
/**
* Sets new popup callback for this button.
*
* @param popupCallback
* New popup callback for this button.
* @see #getPopupCallback()
*/
public void setPopupCallback(PopupPanelCallback popupCallback) {
this.popupCallback = popupCallback;
}
/**
* Sets the auto-repeat action indication.
*
* @param isAutoRepeatAction
* If true, pressing the button will activate
* auto-repeat action mode. When the button is not in the
* auto-repeat action mode, the registered action listeners are
* activated when the mouse is released (just as with the base
* {@link AbstractButton}). When the button is in auto-repeat
* mode, the registered action listeners are activated when the
* mouse is pressed. In addition, is the mouse is still pressed
* after {@link #getAutoRepeatInitialInterval()}, the action
* listeners will be activated every
* {@link #getAutoRepeatSubsequentInterval()} until the button is
* disabled or the mouse is released.
* @see #setAutoRepeatActionIntervals(int, int)
* @see #isAutoRepeatAction()
*/
public void setAutoRepeatAction(boolean isAutoRepeatAction) {
this.isAutoRepeatAction = isAutoRepeatAction;
}
/**
* Sets the intervals for the auto-repeat action mode.
*
* @param initial
* The initial interval for invoking the registered action
* listeners in the auto-repeat action mode.
* @param subsequent
* The subsequent interval for invoking the registered action
* listeners in the auto-repeat action mode.
* @see #setAutoRepeatAction(boolean)
* @see #isAutoRepeatAction()
* @see #getAutoRepeatInitialInterval()
* @see #getAutoRepeatSubsequentInterval()
*/
public void setAutoRepeatActionIntervals(int initial, int subsequent) {
this.autoRepeatInitialInterval = initial;
this.autoRepeatSubsequentInterval = subsequent;
}
/**
* Returns indication whether the button is in auto-repeat action mode.
*
* @return true if the button is in auto-repeat action mode,
* false otherwise.
* @see #setAutoRepeatAction(boolean)
* @see #setAutoRepeatActionIntervals(int, int)
* @see #getAutoRepeatInitialInterval()
* @see #getAutoRepeatSubsequentInterval()
*/
public boolean isAutoRepeatAction() {
return this.isAutoRepeatAction;
}
/**
* Returns the initial interval for invoking the registered action listeners
* in the auto-repeat action mode.
*
* @return The initial interval for invoking the registered action listeners
* in the auto-repeat action mode.
* @see #setAutoRepeatActionIntervals(int, int)
* @see #setAutoRepeatAction(boolean)
* @see #isAutoRepeatAction()
* @see #getAutoRepeatSubsequentInterval()
*/
public int getAutoRepeatInitialInterval() {
return autoRepeatInitialInterval;
}
/**
* Returns the subsequent interval for invoking the registered action
* listeners in the auto-repeat action mode.
*
* @return The subsequent interval for invoking the registered action
* listeners in the auto-repeat action mode.
* @see #setAutoRepeatActionIntervals(int, int)
* @see #setAutoRepeatAction(boolean)
* @see #isAutoRepeatAction()
* @see #getAutoRepeatInitialInterval()
*/
public int getAutoRepeatSubsequentInterval() {
return autoRepeatSubsequentInterval;
}
/**
* Sets action-on-rollover mode. When this mode is on, button will fire
* action events when it gets rollover (instead of press). Combine with
* {@link #setAutoRepeatAction(boolean)} passing true to get
* auto-repeat action fired on rollover (useful for quicker manipulation of
* scroller buttons, for example).
*
* @param isFireActionOnRollover
* If true, the button is moved into the
* action-on-rollover mode.
* @see #isFireActionOnRollover()
*/
public void setFireActionOnRollover(boolean isFireActionOnRollover) {
this.isFireActionOnRollover = isFireActionOnRollover;
}
/**
* Returns indication whether this button is in action-on-rollover mode.
*
* @return true if this button is in action-on-rollover mode,
* false otherwise.
* @see #setFireActionOnRollover(boolean)
*/
public boolean isFireActionOnRollover() {
return this.isFireActionOnRollover;
}
/**
* Returns the popup model of this button.
*
* @return The popup model of this button.
* @see #setPopupModel(PopupButtonModel)
*/
public PopupButtonModel getPopupModel() {
return this.popupModel;
}
/**
* Sets the new popup model for this button. Fires a popupModel
* property change event.
*
* @param newModel
* The new popup model for this button.
* @see #getPopupModel()
*/
public void setPopupModel(PopupButtonModel newModel) {
PopupButtonModel oldModel = getPopupModel();
if (oldModel != null) {
oldModel.removeChangeListener(this.popupHandler);
oldModel.removeActionListener(this.popupHandler);
}
this.popupModel = newModel;
if (newModel != null) {
newModel.addChangeListener(this.popupHandler);
newModel.addActionListener(this.popupHandler);
}
firePropertyChange("popupModel", oldModel, newModel);
if (newModel != oldModel) {
revalidate();
repaint();
}
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.AbstractCommandButton#setEnabled(boolean)
*/
@Override
public void setEnabled(boolean b) {
if (!b && popupModel.isRollover()) {
popupModel.setRollover(false);
}
super.setEnabled(b);
popupModel.setEnabled(b);
}
/**
* Default popup handler.
*
* @author Kirill Grouchnikov
*/
class PopupHandler implements PopupActionListener, ChangeListener {
public void stateChanged(ChangeEvent e) {
fireStateChanged();
repaint();
}
public void actionPerformed(ActionEvent event) {
firePopupActionPerformed(event);
}
}
/**
* 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
*/
protected void firePopupActionPerformed(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] == PopupActionListener.class) {
// Lazily create the event:
if (e == null) {
String actionCommand = event.getActionCommand();
e = new ActionEvent(this, ActionEvent.ACTION_PERFORMED,
actionCommand, event.getWhen(), event
.getModifiers());
}
((PopupActionListener) listeners[i + 1]).actionPerformed(e);
}
}
}
@Override
boolean hasRichTooltips() {
return super.hasRichTooltips() || (this.popupRichTooltip != null);
}
/**
* Sets the rich tooltip for the popup area of this button.
*
* @param richTooltip
* Rich tooltip for the popup area of this button.
* @see #getRichTooltip(MouseEvent)
* @see #setActionRichTooltip(RichTooltip)
*/
public void setPopupRichTooltip(RichTooltip richTooltip) {
this.popupRichTooltip = richTooltip;
RichToolTipManager richToolTipManager = RichToolTipManager
.sharedInstance();
if (this.hasRichTooltips()) {
richToolTipManager.registerComponent(this);
} else {
richToolTipManager.unregisterComponent(this);
}
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AbstractCommandButton#getRichTooltip(java.awt
* .event.MouseEvent)
*/
@Override
public RichTooltip getRichTooltip(MouseEvent event) {
CommandButtonUI ui = this.getUI();
if (ui.getLayoutInfo().actionClickArea.contains(event.getPoint()))
return super.getRichTooltip(event);
if (ui.getLayoutInfo().popupClickArea.contains(event.getPoint()))
return this.popupRichTooltip;
return null;
}
/**
* Returns the key tip for the popup area of this button.
*
* @return The key tip for the popup area of this button.
* @see #setPopupKeyTip(String)
* @see #getActionKeyTip()
*/
public String getPopupKeyTip() {
return this.popupKeyTip;
}
/**
* Sets the key tip for the popup area of this button. Fires a
* popupKeyTip property change event.
*
* @param popupKeyTip
* The key tip for the popup area of this button.
* @see #getPopupKeyTip()
* @see #setActionKeyTip(String)
*/
public void setPopupKeyTip(String popupKeyTip) {
if (!canHaveBothKeyTips() && (popupKeyTip != null)
&& (this.actionKeyTip != null)) {
throw new IllegalArgumentException(
"Action *and* popup keytips are not supported at the same time");
}
String old = this.popupKeyTip;
this.popupKeyTip = popupKeyTip;
this.firePropertyChange("popupKeyTip", old, this.popupKeyTip);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AbstractCommandButton#setActionKeyTip(java.
* lang.String)
*/
@Override
public void setActionKeyTip(String actionKeyTip) {
if (!canHaveBothKeyTips() && (popupKeyTip != null)
&& (this.actionKeyTip != null)) {
throw new IllegalArgumentException(
"Action *and* popup keytips are not supported at the same time");
}
super.setActionKeyTip(actionKeyTip);
}
/**
* Returns indication whether key tips can be installed on both action and
* popup areas of this button. This method is for internal use only.
*
* @return true if key tips can be installed on both action and
* popup areas of this button, false otherwise.
*/
boolean canHaveBothKeyTips() {
return false;
}
/**
* Programmatically perform a "click" on the popup area. This does the same
* thing as if the user had pressed and released the popup area of the
* button.
*/
public void doPopupClick() {
Dimension size = getSize();
PopupButtonModel popupModel = this.getPopupModel();
popupModel.setArmed(true);
popupModel.setPressed(true);
paintImmediately(new Rectangle(0, 0, size.width, size.height));
try {
Thread.sleep(100);
} catch (InterruptedException ie) {
}
popupModel.setPressed(false);
popupModel.setArmed(false);
popupModel.setPopupShowing(true);
paintImmediately(new Rectangle(0, 0, size.width, size.height));
}
}
src/org/pushingpixels/flamingo/api/common/JCommandButtonStrip.java 0000644 0001750 0001750 00000026466 11401230444 024517 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.Component;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.pushingpixels.flamingo.internal.ui.common.BasicCommandButtonStripUI;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonStripUI;
/**
* Button strip component. Provides visual appearance of a strip. The buttons in
* the strip are either drawn horizontally with no horizontal space between them
* or drawn vertically with no vertical space between them.
*
* @author Kirill Grouchnikov
*/
public class JCommandButtonStrip extends JComponent {
/**
* The UI class ID string.
*/
public static final String uiClassID = "CommandButtonStripUI";
/**
* Element state for the buttons in this button strip. Default state is
* {@link CommandButtonDisplayState#SMALL}.
*/
protected CommandButtonDisplayState displayState;
/**
* Scale factor for horizontal gaps.
*
* @see #setVGapScaleFactor(double)
*/
protected double hgapScaleFactor;
/**
* Scale factor for vertical gaps.
*
* @see #setVGapScaleFactor(double)
*/
protected double vgapScaleFactor;
/**
* Button strip orientation.
*
* @author Kirill Grouchnikov
*/
public enum StripOrientation {
/**
* Horizontal strip orientation.
*/
HORIZONTAL,
/**
* Vertical strip orientation.
*/
VERTICAL
}
/**
* Orientation of this strip.
*
* @see #getOrientation()
*/
private StripOrientation orientation;
/**
* Creates an empty horizontally-oriented strip.
*/
public JCommandButtonStrip() {
this(StripOrientation.HORIZONTAL);
}
/**
* Creates an empty strip.
*
* @param orientation
* Orientation for this strip.
*/
public JCommandButtonStrip(StripOrientation orientation) {
this.orientation = orientation;
this.displayState = CommandButtonDisplayState.SMALL;
switch (orientation) {
case HORIZONTAL:
this.hgapScaleFactor = 0.75;
this.vgapScaleFactor = 1.0;
break;
case VERTICAL:
this.hgapScaleFactor = 1.0;
this.vgapScaleFactor = 0.75;
break;
}
this.setOpaque(false);
updateUI();
}
/**
* Sets the display state for the buttons in this button strip. This method
* must be called before adding the first command button. The
* default state is {@link CommandButtonDisplayState#SMALL}.
*
* @param elementState
* New element state for the buttons in this button strip.
*/
public void setDisplayState(CommandButtonDisplayState elementState) {
if (this.getComponentCount() > 0) {
throw new IllegalStateException(
"Can't call this method after buttons have been already added");
}
this.displayState = elementState;
}
/**
* Sets the horizontal gap scale factor for the buttons in this button
* strip. This method must be called before adding the first
* command button.
*
*
* The default horizontal gap scale factor for horizontally oriented strips
* is 0.75. The default horizontal gap scale factor for vertically oriented
* strips is 1.0.
*
*
* @param hgapScaleFactor
* New horizontal gap scale factor for the buttons in this button
* strip.
* @see #setVGapScaleFactor(double)
*/
public void setHGapScaleFactor(double hgapScaleFactor) {
if (this.getComponentCount() > 0) {
throw new IllegalStateException(
"Can't call this method after buttons have been already added");
}
this.hgapScaleFactor = hgapScaleFactor;
}
/**
* Sets the vertical gap scale factor for the buttons in this button strip.
* This method must be called before adding the first command
* button.
*
*
* The default vertical gap scale factor for vertically oriented strips is
* 0.75. The default vertical gap scale factor for horizontally oriented
* strips is 1.0.
*
*
* @param vgapScaleFactor
* New vertical gap scale factor for the buttons in this button
* strip.
* @see #setHGapScaleFactor(double)
*/
public void setVGapScaleFactor(double vgapScaleFactor) {
if (this.getComponentCount() > 0) {
throw new IllegalStateException(
"Can't call this method after buttons have been already added");
}
this.vgapScaleFactor = vgapScaleFactor;
}
/*
* (non-Javadoc)
*
* @see java.awt.Container#add(java.awt.Component, java.lang.Object, int)
*/
@Override
public void add(Component comp, Object constraints, int index) {
throw new UnsupportedOperationException();
}
/*
* (non-Javadoc)
*
* @see java.awt.Container#add(java.awt.Component, java.lang.Object)
*/
@Override
public void add(Component comp, Object constraints) {
throw new UnsupportedOperationException();
}
/*
* (non-Javadoc)
*
* @see java.awt.Container#add(java.awt.Component, int)
*/
@Override
public Component add(Component comp, int index) {
if (!(comp instanceof AbstractCommandButton))
throw new UnsupportedOperationException();
this.configureCommandButton((AbstractCommandButton) comp);
return super.add(comp, index);
}
/*
* (non-Javadoc)
*
* @see java.awt.Container#add(java.awt.Component)
*/
@Override
public Component add(Component comp) {
if (!(comp instanceof AbstractCommandButton))
throw new UnsupportedOperationException();
try {
this.configureCommandButton((AbstractCommandButton) comp);
Component result = super.add(comp);
return result;
} finally {
this.fireStateChanged();
}
}
/**
* Configures the specified command button.
*
* @param button
* Command button to configure.
*/
private void configureCommandButton(AbstractCommandButton button) {
button.setDisplayState(this.displayState);
button.setHGapScaleFactor(this.hgapScaleFactor);
button.setVGapScaleFactor(this.vgapScaleFactor);
button.setFlat(false);
}
/*
* (non-Javadoc)
*
* @see java.awt.Container#add(java.lang.String, java.awt.Component)
*/
@Override
public Component add(String name, Component comp) {
throw new UnsupportedOperationException();
}
/**
* Sets the new UI delegate.
*
* @param ui
* New UI delegate.
*/
public void setUI(CommandButtonStripUI ui) {
super.setUI(ui);
}
/**
* Resets the UI property to a value from the current look and feel.
*
* @see JComponent#updateUI
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((CommandButtonStripUI) UIManager.getUI(this));
} else {
setUI(BasicCommandButtonStripUI.createUI(this));
}
}
/**
* Returns the UI object which implements the L&F for this component.
*
* @return a ButtonStripUI object
* @see #setUI
*/
public CommandButtonStripUI getUI() {
return (CommandButtonStripUI) ui;
}
/**
* Returns the name of the UI class that implements the L&F for this
* component.
*
* @return the string "ButtonStripUI"
* @see JComponent#getUIClassID
* @see UIDefaults#getUI
*/
@Override
public String getUIClassID() {
return uiClassID;
}
/**
* Returns the number of buttons in this strip.
*
* @return Number of buttons in this strip.
* @see #getButton(int)
*/
public int getButtonCount() {
return this.getComponentCount();
}
/**
* Returns the specified button component of this strip.
*
* @param index
* Button index.
* @return The matching button.
* @see #getButtonCount()
*/
public AbstractCommandButton getButton(int index) {
return (AbstractCommandButton) this.getComponent(index);
}
/**
* Checks whether the specified button is the first button in
* this strip.
*
* @param button
* Button to check.
* @return true if the specified button is the first button in
* this strip, false otherwise.
* @see #isLast(AbstractCommandButton)
*/
public boolean isFirst(AbstractCommandButton button) {
return (button == this.getButton(0));
}
/**
* Checks whether the specified button is the last button in
* this strip.
*
* @param button
* Button to check.
* @return true if the specified button is the last button in
* this strip, false otherwise.
* @see #isFirst(AbstractCommandButton)
*/
public boolean isLast(AbstractCommandButton button) {
return (button == this.getButton(this.getButtonCount() - 1));
}
/**
* Returns the orientation of this strip.
*
* @return Orientation of this strip.
*/
public StripOrientation getOrientation() {
return orientation;
}
/**
* Adds the specified change listener to track changes to this command
* button strip.
*
* @param l
* Change listener to add.
* @see #removeChangeListener(ChangeListener)
*/
public void addChangeListener(ChangeListener l) {
this.listenerList.add(ChangeListener.class, l);
}
/**
* Removes the specified change listener from tracking changes to this
* command button strip.
*
* @param l
* Change listener to remove.
* @see #addChangeListener(ChangeListener)
*/
public void removeChangeListener(ChangeListener l) {
this.listenerList.remove(ChangeListener.class, l);
}
/**
* Notifies all registered listener that the state of this command button
* strip has changed.
*/
protected void fireStateChanged() {
// Guaranteed to return a non-null array
Object[] listeners = this.listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
ChangeEvent event = new ChangeEvent(this);
for (int i = listeners.length - 2; i >= 0; i -= 2) {
if (listeners[i] == ChangeListener.class) {
((ChangeListener) listeners[i + 1]).stateChanged(event);
}
}
}
}
src/org/pushingpixels/flamingo/api/common/JScrollablePanel.java 0000644 0001750 0001750 00000010651 11401230444 023752 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.pushingpixels.flamingo.internal.ui.common.BasicScrollablePanelUI;
import org.pushingpixels.flamingo.internal.ui.common.ScrollablePanelUI;
/**
* ScrollablePanel allows to have scrolling buttons on each side.
*/
public class JScrollablePanel extends JPanel {
/**
* @see #getUIClassID
*/
public static final String uiClassID = "ScrollablePanelUI";
private T view;
private ScrollType scrollType;
private boolean isScrollOnRollover;
public enum ScrollType {
VERTICALLY, HORIZONTALLY
}
public JScrollablePanel(T c, final ScrollType scrollType) {
super();
this.view = c;
this.scrollType = scrollType;
this.isScrollOnRollover = true;
this.updateUI();
}
/*
* (non-Javadoc)
*
* @see javax.swing.JPanel#getUI()
*/
@Override
public ScrollablePanelUI getUI() {
return (ScrollablePanelUI) ui;
}
/*
* (non-Javadoc)
*
* @see javax.swing.JPanel#getUIClassID()
*/
@Override
public String getUIClassID() {
return uiClassID;
}
/*
* (non-Javadoc)
*
* @see javax.swing.JPanel#updateUI()
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((ScrollablePanelUI) UIManager.getUI(this));
} else {
setUI(BasicScrollablePanelUI.createUI(this));
}
}
public void setScrollOnRollover(boolean toScrollOnRollover) {
boolean old = this.isScrollOnRollover;
this.isScrollOnRollover = toScrollOnRollover;
if (old != this.isScrollOnRollover) {
this.firePropertyChange("scrollOnRollover", old,
this.isScrollOnRollover);
}
}
public void scrollToIfNecessary(int startPosition, int span) {
this.getUI().scrollToIfNecessary(startPosition, span);
}
public T getView() {
return view;
}
public void addChangeListener(ChangeListener l) {
listenerList.add(ChangeListener.class, l);
}
public void removeChangeListener(ChangeListener l) {
listenerList.remove(ChangeListener.class, l);
}
protected void fireStateChanged() {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
ChangeEvent changeEvent = new ChangeEvent(this);
for (int i = listeners.length - 2; i >= 0; i -= 2) {
if (listeners[i] == ChangeListener.class) {
((ChangeListener) listeners[i + 1]).stateChanged(changeEvent);
}
}
}
@Override
public void doLayout() {
super.doLayout();
this.fireStateChanged();
}
public ScrollType getScrollType() {
return scrollType;
}
public boolean isScrollOnRollover() {
return this.isScrollOnRollover;
}
public boolean isShowingScrollButtons() {
return this.getUI().isShowingScrollButtons();
}
}
src/org/pushingpixels/flamingo/api/common/JCommandToggleMenuButton.java 0000644 0001750 0001750 00000006025 11401230444 025451 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import javax.swing.UIManager;
import org.pushingpixels.flamingo.api.common.icon.ResizableIcon;
import org.pushingpixels.flamingo.api.common.popup.JCommandPopupMenu;
import org.pushingpixels.flamingo.internal.ui.common.BasicCommandToggleMenuButtonUI;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI;
/**
* A command toggle button that can be placed in {@link JCommandPopupMenu}.
*
* @author Kirill Grouchnikov
* @see JCommandPopupMenu#addMenuButton(JCommandToggleMenuButton)
*/
public class JCommandToggleMenuButton extends JCommandToggleButton {
/**
* The UI class ID string.
*/
public static final String uiClassID = "CommandToggleMenuButtonUI";
/**
* Creates a new command toggle menu button.
*
* @param title
* Command toggle menu button title.
* @param icon
* Command toggle menu button icon.
*/
public JCommandToggleMenuButton(String title, ResizableIcon icon) {
super(title, icon);
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#getUIClassID()
*/
@Override
public String getUIClassID() {
return uiClassID;
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#updateUI()
*/
@Override
public void updateUI() {
if (UIManager.get(getUIClassID()) != null) {
setUI((CommandButtonUI) UIManager.getUI(this));
} else {
setUI(BasicCommandToggleMenuButtonUI.createUI(this));
}
}
}
src/org/pushingpixels/flamingo/api/common/AbstractCommandButton.java 0000644 0001750 0001750 00000055050 11401230444 025036 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.awt.event.*;
import javax.accessibility.AccessibleContext;
import javax.swing.ButtonModel;
import javax.swing.SwingConstants;
import javax.swing.event.*;
import org.pushingpixels.flamingo.api.common.icon.ResizableIcon;
import org.pushingpixels.flamingo.api.common.model.ActionButtonModel;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonUI;
/**
* Base class for command buttons.
*
* @author Kirill Grouchnikov
*/
public abstract class AbstractCommandButton extends
RichToolTipManager.JTrackableComponent {
/**
* Associated icon.
*
* @see #setIcon(ResizableIcon)
* @see #getIcon()
*/
protected ResizableIcon icon;
/**
* Associated disabled icon.
*
* @see #setDisabledIcon(ResizableIcon)
* @see #getDisabledIcon()
*/
protected ResizableIcon disabledIcon;
/**
* The button text.
*
* @see #setText(String)
* @see #getText()
*/
private String text;
/**
* The button action model.
*
* @see #getActionModel()
* @see #setActionModel(ActionButtonModel)
*/
protected ActionButtonModel actionModel;
/**
* Additional text. This is shown for {@link CommandButtonDisplayState#TILE}
* .
*
* @see #setExtraText(String)
* @see #getExtraText()
*/
protected String extraText;
/**
* Current display state of this button.
*
* @see #setDisplayState(CommandButtonDisplayState)
* @see #getDisplayState()
*/
protected CommandButtonDisplayState displayState;
/**
* The dimension of the icon of the associated command button in the
* {@link CommandButtonDisplayState#FIT_TO_ICON} state.
*
* @see #getCustomDimension()
* @see #updateCustomDimension(int)
*/
protected int customDimension;
/**
* Indication whether this button is flat.
*
* @see #setFlat(boolean)
* @see #isFlat()
*/
protected boolean isFlat;
/**
* Horizontal alignment of the content.
*
* @see #setHorizontalAlignment(int)
* @see #getHorizontalAlignment()
*/
private int horizontalAlignment;
/**
* Scale factor for horizontal gaps.
*
* @see #setHGapScaleFactor(double)
* @see #getHGapScaleFactor()
*/
private double hgapScaleFactor;
/**
* Scale factor for vertical gaps.
*
* @see #setVGapScaleFactor(double)
* @see #getVGapScaleFactor()
*/
private double vgapScaleFactor;
/**
* Rich tooltip for the action area.
*
* @see #setActionRichTooltip(RichTooltip)
* @see #getRichTooltip(MouseEvent)
*/
private RichTooltip actionRichTooltip;
/**
* Location order kind for buttons placed in command button strips or for
* buttons that need the visuals of segmented strips.
*
* @see #setLocationOrderKind(CommandButtonLocationOrderKind)
* @see #getLocationOrderKind()
*/
private CommandButtonLocationOrderKind locationOrderKind;
/**
* Action handler for the button.
*/
protected ActionHandler actionHandler;
/**
* Key tip for the action area.
*
* @see #setActionKeyTip(String)
* @see #getActionKeyTip()
*/
protected String actionKeyTip;
/**
* Enumerates the available values for the location order kind. This is used
* for buttons placed in command button strips or for buttons that need the
* visuals of segmented strips.
*
* @author Kirill Grouchnikov
*/
public static enum CommandButtonLocationOrderKind {
/**
* Indicates that this button is the only button in the strip.
*/
ONLY,
/**
* Indicates that this button is the first button in the strip.
*/
FIRST,
/**
* Indicates that this button is in the middle of the strip.
*/
MIDDLE,
/**
* Indicates that this button is the last button in the strip.
*/
LAST
}
/**
* Creates a new command button.
*
* @param text
* Button title. May contain any number of words.
* @param icon
* Button icon.
*/
public AbstractCommandButton(String text, ResizableIcon icon) {
this.icon = icon;
this.customDimension = -1;
this.displayState = CommandButtonDisplayState.FIT_TO_ICON;
this.horizontalAlignment = SwingConstants.CENTER;
this.actionHandler = new ActionHandler();
this.isFlat = true;
this.hgapScaleFactor = 1.0;
this.vgapScaleFactor = 1.0;
this.setText(text);
this.setOpaque(false);
}
/**
* Sets the new UI delegate.
*
* @param ui
* New UI delegate.
*/
public void setUI(CommandButtonUI ui) {
super.setUI(ui);
}
/**
* Returns the UI delegate for this button.
*
* @return The UI delegate for this button.
*/
public CommandButtonUI getUI() {
return (CommandButtonUI) ui;
}
/**
* Sets new display state for this button. Fires a
* displayState property change event.
*
* @param state
* New display state.
* @see #getDisplayState()
*/
public void setDisplayState(CommandButtonDisplayState state) {
CommandButtonDisplayState old = this.displayState;
this.displayState = state;
this.firePropertyChange("displayState", old, this.displayState);
}
/**
* Returns the associated icon.
*
* @return The associated icon.
* @see #getDisabledIcon()
* @see #setIcon(ResizableIcon)
*/
public ResizableIcon getIcon() {
return icon;
}
/**
* Sets new icon for this button. Fires an icon property change
* event.
*
* @param defaultIcon
* New default icon for this button.
* @see #setDisabledIcon(ResizableIcon)
* @see #getIcon()
*/
public void setIcon(ResizableIcon defaultIcon) {
ResizableIcon oldValue = this.icon;
this.icon = defaultIcon;
firePropertyChange("icon", oldValue, defaultIcon);
if (defaultIcon != oldValue) {
if (defaultIcon == null || oldValue == null
|| defaultIcon.getIconWidth() != oldValue.getIconWidth()
|| defaultIcon.getIconHeight() != oldValue.getIconHeight()) {
revalidate();
}
repaint();
}
}
/**
* Sets the disabled icon for this button.
*
* @param disabledIcon
* Disabled icon for this button.
* @see #setIcon(ResizableIcon)
* @see #getDisabledIcon()
*/
public void setDisabledIcon(ResizableIcon disabledIcon) {
this.disabledIcon = disabledIcon;
}
/**
* Returns the associated disabled icon.
*
* @return The associated disabled icon.
* @see #setDisabledIcon(ResizableIcon)
* @see #getIcon()
*/
public ResizableIcon getDisabledIcon() {
return disabledIcon;
}
/**
* Return the current display state of this button.
*
* @return The current display state of this button.
* @see #setDisplayState(CommandButtonDisplayState)
*/
public CommandButtonDisplayState getDisplayState() {
return displayState;
}
/**
* Returns the extra text of this button.
*
* @return Extra text of this button.
* @see #setExtraText(String)
*/
public String getExtraText() {
return this.extraText;
}
/**
* Sets the extra text for this button. Fires an extraText
* property change event.
*
* @param extraText
* Extra text for this button.
* @see #getExtraText()
*/
public void setExtraText(String extraText) {
String oldValue = this.extraText;
this.extraText = extraText;
firePropertyChange("extraText", oldValue, extraText);
if (accessibleContext != null) {
accessibleContext.firePropertyChange(
AccessibleContext.ACCESSIBLE_VISIBLE_DATA_PROPERTY,
oldValue, extraText);
}
if (extraText == null || oldValue == null
|| !extraText.equals(oldValue)) {
revalidate();
repaint();
}
}
/**
* Returns the text of this button.
*
* @return The text of this button.
* @see #setText(String)
*/
public String getText() {
return this.text;
}
/**
* Sets the new text for this button. Fires a text property
* change event.
*
* @param text
* The new text for this button.
* @see #getText()
*/
public void setText(String text) {
String oldValue = this.text;
this.text = text;
firePropertyChange("text", oldValue, text);
if (accessibleContext != null) {
accessibleContext.firePropertyChange(
AccessibleContext.ACCESSIBLE_VISIBLE_DATA_PROPERTY,
oldValue, text);
}
if (text == null || oldValue == null || !text.equals(oldValue)) {
revalidate();
repaint();
}
}
/**
* Updates the dimension of the icon of the associated command button in the
* {@link CommandButtonDisplayState#FIT_TO_ICON} state. Fires a
* customDimension property change event.
*
* @param dimension
* New dimension of the icon of the associated command button in
* the {@link CommandButtonDisplayState#FIT_TO_ICON} state.
* @see #getCustomDimension()
*/
public void updateCustomDimension(int dimension) {
if (this.customDimension != dimension) {
int old = this.customDimension;
this.customDimension = dimension;
this.firePropertyChange("customDimension", old,
this.customDimension);
}
}
/**
* Returns the dimension of the icon of the associated command button in the
* {@link CommandButtonDisplayState#FIT_TO_ICON} state.
*
* @return The dimension of the icon of the associated command button in the
* {@link CommandButtonDisplayState#FIT_TO_ICON} state.
* @see #updateCustomDimension(int)
*/
public int getCustomDimension() {
return this.customDimension;
}
/**
* Returns indication whether this button has flat appearance.
*
* @return true if this button has flat appearance,
* false otherwise.
* @see #setFlat(boolean)
*/
public boolean isFlat() {
return this.isFlat;
}
/**
* Sets the flat appearance of this button. Fires a flat
* property change event.
*
* @param isFlat
* If true, this button will have flat appearance,
* otherwise this button will not have flat appearance.
* @see #isFlat()
*/
public void setFlat(boolean isFlat) {
boolean old = this.isFlat;
this.isFlat = isFlat;
if (old != this.isFlat) {
this.firePropertyChange("flat", old, this.isFlat);
}
if (old != isFlat) {
repaint();
}
}
/**
* Returns the action model for this button.
*
* @return The action model for this button.
* @see #setActionModel(ActionButtonModel)
*/
public ActionButtonModel getActionModel() {
return this.actionModel;
}
/**
* Sets the new action model for this button. Fires an
* actionModel property change event.
*
* @param newModel
* The new action model for this button.
* @see #getActionModel()
*/
public void setActionModel(ActionButtonModel newModel) {
ButtonModel oldModel = getActionModel();
if (oldModel != null) {
oldModel.removeChangeListener(this.actionHandler);
oldModel.removeActionListener(this.actionHandler);
}
actionModel = newModel;
if (newModel != null) {
newModel.addChangeListener(this.actionHandler);
newModel.addActionListener(this.actionHandler);
}
firePropertyChange("actionModel", oldModel, newModel);
if (newModel != oldModel) {
revalidate();
repaint();
}
}
/**
* Adds the specified action listener to this button.
*
* @param l
* Action listener to add.
* @see #removeActionListener(ActionListener)
*/
public void addActionListener(ActionListener l) {
this.listenerList.add(ActionListener.class, l);
}
/**
* Removes the specified action listener from this button.
*
* @param l
* Action listener to remove.
* @see #addActionListener(ActionListener)
*/
public void removeActionListener(ActionListener l) {
this.listenerList.remove(ActionListener.class, l);
}
/**
* Adds the specified change listener to this button.
*
* @param l
* Change listener to add.
* @see #removeChangeListener(ChangeListener)
*/
public void addChangeListener(ChangeListener l) {
this.listenerList.add(ChangeListener.class, l);
}
/**
* Removes the specified change listener from this button.
*
* @param l
* Change listener to remove.
* @see #addChangeListener(ChangeListener)
*/
public void removeChangeListener(ChangeListener l) {
this.listenerList.remove(ChangeListener.class, l);
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#setEnabled(boolean)
*/
@Override
public void setEnabled(boolean b) {
if (!b && actionModel.isRollover()) {
actionModel.setRollover(false);
}
super.setEnabled(b);
actionModel.setEnabled(b);
}
/**
* Default action handler for this button.
*
* @author Kirill Grouchnikov
*/
class ActionHandler implements ActionListener, ChangeListener {
public void stateChanged(ChangeEvent e) {
fireStateChanged();
repaint();
}
public void actionPerformed(ActionEvent event) {
fireActionPerformed(event);
}
}
/**
* Notifies all listeners that have registered interest for notification on
* this event type. The event instance is lazily created.
*
* @see EventListenerList
*/
protected void fireStateChanged() {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
ChangeEvent ce = new ChangeEvent(this);
for (int i = listeners.length - 2; i >= 0; i -= 2) {
if (listeners[i] == ChangeListener.class) {
// Lazily create the event:
((ChangeListener) listeners[i + 1]).stateChanged(ce);
}
}
}
/**
* 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
*/
protected void fireActionPerformed(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] == ActionListener.class) {
// Lazily create the event:
if (e == null) {
String actionCommand = event.getActionCommand();
e = new ActionEvent(this, ActionEvent.ACTION_PERFORMED,
actionCommand, event.getWhen(), event
.getModifiers());
}
((ActionListener) listeners[i + 1]).actionPerformed(e);
}
}
}
/**
* Sets new horizontal alignment for the content of this button. Fires a
* horizontalAlignment property change event.
*
* @param alignment
* New horizontal alignment for the content of this button.
* @see #getHorizontalAlignment()
*/
public void setHorizontalAlignment(int alignment) {
if (alignment == this.horizontalAlignment)
return;
int oldValue = this.horizontalAlignment;
this.horizontalAlignment = alignment;
firePropertyChange("horizontalAlignment", oldValue,
this.horizontalAlignment);
repaint();
}
/**
* Returns the horizontal alignment for the content of this button.
*
* @return The horizontal alignment for the content of this button.
* @see #setHorizontalAlignment(int)
*/
public int getHorizontalAlignment() {
return this.horizontalAlignment;
}
/**
* Sets new horizontal gap scale factor for the content of this button.
* Fires an hgapScaleFactor property change event.
*
* @param hgapScaleFactor
* New horizontal gap scale factor for the content of this
* button.
* @see #getHGapScaleFactor()
* @see #setVGapScaleFactor(double)
* @see #setGapScaleFactor(double)
*/
public void setHGapScaleFactor(double hgapScaleFactor) {
if (hgapScaleFactor == this.hgapScaleFactor)
return;
double oldValue = this.hgapScaleFactor;
this.hgapScaleFactor = hgapScaleFactor;
firePropertyChange("hgapScaleFactor", oldValue, this.hgapScaleFactor);
if (this.hgapScaleFactor != oldValue) {
revalidate();
repaint();
}
}
/**
* Sets new vertical gap scale factor for the content of this button. Fires
* a vgapScaleFactor property change event.
*
* @param vgapScaleFactor
* New vertical gap scale factor for the content of this button.
* @see #getVGapScaleFactor()
* @see #setHGapScaleFactor(double)
* @see #setGapScaleFactor(double)
*/
public void setVGapScaleFactor(double vgapScaleFactor) {
if (vgapScaleFactor == this.vgapScaleFactor)
return;
double oldValue = this.vgapScaleFactor;
this.vgapScaleFactor = vgapScaleFactor;
firePropertyChange("vgapScaleFactor", oldValue, this.vgapScaleFactor);
if (this.vgapScaleFactor != oldValue) {
revalidate();
repaint();
}
}
/**
* Sets new gap scale factor for the content of this button.
*
* @param gapScaleFactor
* New gap scale factor for the content of this button.
* @see #getHGapScaleFactor()
* @see #getVGapScaleFactor()
*/
public void setGapScaleFactor(double gapScaleFactor) {
setHGapScaleFactor(gapScaleFactor);
setVGapScaleFactor(gapScaleFactor);
}
/**
* Returns the horizontal gap scale factor for the content of this button.
*
* @return The horizontal gap scale factor for the content of this button.
* @see #setHGapScaleFactor(double)
* @see #setGapScaleFactor(double)
* @see #getVGapScaleFactor()
*/
public double getHGapScaleFactor() {
return this.hgapScaleFactor;
}
/**
* Returns the vertical gap scale factor for the content of this button.
*
* @return The vertical gap scale factor for the content of this button.
* @see #setVGapScaleFactor(double)
* @see #setGapScaleFactor(double)
* @see #getHGapScaleFactor()
*/
public double getVGapScaleFactor() {
return this.vgapScaleFactor;
}
/**
* Programmatically perform an action "click". This does the same thing as
* if the user had pressed and released the action area of the button.
*/
public void doActionClick() {
Dimension size = getSize();
ButtonModel actionModel = this.getActionModel();
actionModel.setArmed(true);
actionModel.setPressed(true);
paintImmediately(new Rectangle(0, 0, size.width, size.height));
try {
Thread.sleep(100);
} catch (InterruptedException ie) {
}
actionModel.setPressed(false);
actionModel.setArmed(false);
}
boolean hasRichTooltips() {
return (this.actionRichTooltip != null);
}
/**
* Sets the rich tooltip for the action area of this button.
*
* @param richTooltip
* Rich tooltip for the action area of this button.
* @see #getRichTooltip(MouseEvent)
*/
public void setActionRichTooltip(RichTooltip richTooltip) {
this.actionRichTooltip = richTooltip;
RichToolTipManager richToolTipManager = RichToolTipManager
.sharedInstance();
if (this.hasRichTooltips()) {
richToolTipManager.registerComponent(this);
} else {
richToolTipManager.unregisterComponent(this);
}
}
/*
* (non-Javadoc)
*
* @seeorg.jvnet.flamingo.common.RichToolTipManager.JTrackableComponent#
* getRichTooltip(java.awt.event.MouseEvent)
*/
@Override
public RichTooltip getRichTooltip(MouseEvent mouseEvent) {
return this.actionRichTooltip;
}
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#setToolTipText(java.lang.String)
*/
@Override
public void setToolTipText(String text) {
throw new UnsupportedOperationException("Use rich tooltip APIs");
}
/**
* Returns the location order kind for buttons placed in command button
* strips or for buttons that need the visuals of segmented strips.
*
* @return The location order kind for buttons placed in command button
* strips or for buttons that need the visuals of segmented strips.
* @see #setLocationOrderKind(CommandButtonLocationOrderKind)
*/
public CommandButtonLocationOrderKind getLocationOrderKind() {
return this.locationOrderKind;
}
/**
* Sets the location order kind for buttons placed in command button strips
* or for buttons that need the visuals of segmented strips. Fires a
* locationOrderKind property change event.
*
* @param locationOrderKind
* The location order kind for buttons placed in command button
* strips or for buttons that need the visuals of segmented
* strips.
* @see #getLocationOrderKind()
*/
public void setLocationOrderKind(
CommandButtonLocationOrderKind locationOrderKind) {
CommandButtonLocationOrderKind old = this.locationOrderKind;
if (old != locationOrderKind) {
this.locationOrderKind = locationOrderKind;
this.firePropertyChange("locationOrderKind", old,
this.locationOrderKind);
}
}
/**
* Returns the key tip for the action area of this button.
*
* @return The key tip for the action area of this button.
* @see #setActionKeyTip(String)
*/
public String getActionKeyTip() {
return this.actionKeyTip;
}
/**
* Sets the key tip for the action area of this button. Fires an
* actionKeyTip property change event.
*
* @param actionKeyTip
* The key tip for the action area of this button.
* @see #getActionKeyTip()
*/
public void setActionKeyTip(String actionKeyTip) {
String old = this.actionKeyTip;
this.actionKeyTip = actionKeyTip;
this.firePropertyChange("actionKeyTip", old, this.actionKeyTip);
}
}
src/org/pushingpixels/flamingo/api/common/CommandButtonDisplayState.java 0000644 0001750 0001750 00000012010 11401230444 025666 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import org.pushingpixels.flamingo.internal.ui.common.*;
/**
* Display state for command buttons. This class provides a number of core
* display states, and it is possible to create additional custom states by
* using the protected constructor and implementing the relevant abstract
* methods.
*
* @author Kirill Grouchnikov
*/
public abstract class CommandButtonDisplayState {
/**
* Fit to icon state.
*/
public static final CommandButtonDisplayState FIT_TO_ICON = new CommandButtonDisplayState(
"Fit to icon", -1) {
@Override
public CommandButtonLayoutManager createLayoutManager(
AbstractCommandButton commandButton) {
return new CommandButtonLayoutManagerCustom(commandButton);
}
};
/**
* Big state.
*/
public static final CommandButtonDisplayState BIG = new CommandButtonDisplayState(
"Big", 32) {
@Override
public CommandButtonLayoutManager createLayoutManager(
AbstractCommandButton commandButton) {
return new CommandButtonLayoutManagerBig(commandButton);
}
};
/**
* Tile state.
*/
public static final CommandButtonDisplayState TILE = new CommandButtonDisplayState(
"Tile", 32) {
@Override
public CommandButtonLayoutManager createLayoutManager(
AbstractCommandButton arg0) {
return new CommandButtonLayoutManagerTile();
}
};
/**
* Medium state.
*/
public static final CommandButtonDisplayState MEDIUM = new CommandButtonDisplayState(
"Medium", 16) {
@Override
public CommandButtonLayoutManager createLayoutManager(
AbstractCommandButton arg0) {
return new CommandButtonLayoutManagerMedium();
}
};
/**
* Small state.
*/
public static final CommandButtonDisplayState SMALL = new CommandButtonDisplayState(
"Small", 16) {
@Override
public CommandButtonLayoutManager createLayoutManager(
AbstractCommandButton arg0) {
return new CommandButtonLayoutManagerSmall();
}
};
/**
* Preferred icon size for this state.
*
* @see #CommandButtonDisplayState(String, int)
* @see #getPreferredIconSize()
*/
int preferredIconSize;
/**
* Display name for this state.
*
* @see #CommandButtonDisplayState(String, int)
* @see #getDisplayName()
*/
String displayName;
/**
* Creates a new element state.
*
* @param displayName
* Display name.
* @param preferredIconSize
* Preferred icon size.
*/
protected CommandButtonDisplayState(String displayName,
int preferredIconSize) {
this.displayName = displayName;
this.preferredIconSize = preferredIconSize;
}
/**
* Returns the display name for this state.
*
* @return The display name for this state.
* @see #CommandButtonDisplayState(String, int)
*/
public String getDisplayName() {
return this.displayName;
}
/**
* Returns the preferred icon size for this state.
*
* @return The preferred icon size for this state.
* @see #CommandButtonDisplayState(String, int)
*/
public int getPreferredIconSize() {
return this.preferredIconSize;
}
/**
* Creates a layout manager for the specified button.
*
* @param commandButton
* Command button.
* @return A layout manager for the specified button.
*/
public abstract CommandButtonLayoutManager createLayoutManager(
AbstractCommandButton commandButton);
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return this.getDisplayName();
}
}
src/org/pushingpixels/flamingo/api/common/icon/ 0000755 0001750 0001750 00000000000 11401230444 020660 5 ustar tony tony src/org/pushingpixels/flamingo/api/common/icon/LayeredIcon.java 0000644 0001750 0001750 00000005635 11401230444 023732 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
/**
* Decorator icon that layers icons one on top of the other. The original icons
* are drawn and resized together as one layered stack.
*
* @author Kirill Grouchnikov
*/
public class LayeredIcon implements ResizableIcon {
/**
* The layer icons.
*/
protected ResizableIcon[] layers;
/**
* Creates a new layered icon.
*
* @param layers
* Layer icons.
*/
public LayeredIcon(ResizableIcon... layers) {
this.layers = layers;
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.ResizableIcon#setDimension(java.awt.Dimension)
*/
public void setDimension(Dimension newDimension) {
for (ResizableIcon layer : layers)
layer.setDimension(newDimension);
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return layers[0].getIconHeight();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return layers[0].getIconWidth();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y) {
for (ResizableIcon layer : layers)
layer.paintIcon(c, g, x, y);
}
}
src/org/pushingpixels/flamingo/api/common/icon/DecoratedResizableIcon.java 0000644 0001750 0001750 00000014514 11401230444 026074 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
import java.util.ArrayList;
import org.pushingpixels.flamingo.api.common.AsynchronousLoadListener;
import org.pushingpixels.flamingo.api.common.AsynchronousLoading;
/**
* Implementation of {@link ResizableIcon} that adds decorations to a main icon.
*
* @author Kirill Grouchnikov
*/
public class DecoratedResizableIcon implements ResizableIcon,
AsynchronousLoading {
/**
* The main delegate icon.
*/
protected ResizableIcon delegate;
/**
* List of icon decorators.
*/
protected java.util.List decorators;
/**
* Icon decorator interface.
*
* @author Kirill Grouchnikov
*/
public static interface IconDecorator {
/**
* Paints the icon decoration.
*
* @param c
* Component.
* @param g
* Graphics context.
* @param mainIconX
* X position of main icon painting.
* @param mainIconY
* Y position of main icon painting.
* @param mainIconWidth
* Width of main icon.
* @param mainIconHeight
* Height of main icon.
*/
public void paintIconDecoration(Component c, Graphics g, int mainIconX,
int mainIconY, int mainIconWidth, int mainIconHeight);
}
/**
* Creates a new decorated icon.
*
* @param delegate
* The main icon.
* @param decorators
* Icon decorators.
*/
public DecoratedResizableIcon(ResizableIcon delegate,
IconDecorator... decorators) {
this.delegate = delegate;
this.decorators = new ArrayList();
if (decorators != null) {
for (IconDecorator decorator : decorators) {
this.decorators.add(decorator);
}
}
}
/**
* Creates a new decorated icon with no decorators. Decorators can be added
* later with {@link #addIconDecorator(IconDecorator)}.
*
* @param delegate
* Main icon.
*/
public DecoratedResizableIcon(ResizableIcon delegate) {
this(delegate, (IconDecorator) null);
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return this.delegate.getIconHeight();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return this.delegate.getIconWidth();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y) {
this.delegate.paintIcon(c, g, x, y);
for (IconDecorator decorator : this.decorators) {
decorator.paintIconDecoration(c, g, x, y, this.delegate
.getIconWidth(), this.delegate.getIconHeight());
}
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.icon.ResizableIcon#setDimension(java.awt.Dimension
* )
*/
public void setDimension(Dimension newDimension) {
this.delegate.setDimension(newDimension);
}
/**
* Adds the specified decorator to the end of the decorator sequence. If the
* specified decorator already exists, it is not moved to the end of the
* sequence.
*
* @param decorator
* Decorator to add.
*/
public void addIconDecorator(IconDecorator decorator) {
if (this.decorators.contains(decorator))
return;
this.decorators.add(decorator);
}
/**
* Removes the specified decorator.
*
* @param decorator
* Decorator to remove.
*/
public void removeIconDecorator(IconDecorator decorator) {
this.decorators.remove(decorator);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#addAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
@Override
public void addAsynchronousLoadListener(AsynchronousLoadListener l) {
if (this.delegate instanceof AsynchronousLoading) {
((AsynchronousLoading) this.delegate)
.addAsynchronousLoadListener(l);
}
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#removeAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
@Override
public void removeAsynchronousLoadListener(AsynchronousLoadListener l) {
if (this.delegate instanceof AsynchronousLoading) {
((AsynchronousLoading) this.delegate)
.removeAsynchronousLoadListener(l);
}
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.AsynchronousLoading#isLoading()
*/
@Override
public synchronized boolean isLoading() {
if (this.delegate instanceof AsynchronousLoading) {
if (((AsynchronousLoading) this.delegate).isLoading())
return true;
}
for (IconDecorator decorator : this.decorators) {
if (decorator instanceof AsynchronousLoading) {
if (((AsynchronousLoading) decorator).isLoading())
return true;
}
}
return false;
}
}
src/org/pushingpixels/flamingo/api/common/icon/IconDeckResizableIcon.java 0000644 0001750 0001750 00000012001 11401230444 025646 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
import java.util.Map;
import org.pushingpixels.flamingo.api.common.AsynchronousLoadListener;
import org.pushingpixels.flamingo.api.common.AsynchronousLoading;
/**
* Implementation of the {@link ResizableIcon} that allows switching the icon
* painting at runtime. This class can be used as a delegate in the
* {@link DecoratedResizableIcon} where the "base" icon is changed at runtime
* without the need to recompute all the decorators.
*
* @param
* enumeration key into the deck
* @author Kenneth Flynn flynnk@darkcornersoftware.com.
*/
public class IconDeckResizableIcon implements ResizableIcon,
AsynchronousLoading {
/**
* Currently shown icon.
*/
private ResizableIcon currentIcon;
/**
* The icon deck.
*/
private final Map iconDeck;
/**
* Creates the icon deck.
*
* @param iconDeck
* Icon deck.
*/
public IconDeckResizableIcon(Map iconDeck) {
if (iconDeck.isEmpty())
throw new IllegalArgumentException(
"Icon deck is empty; must have at least one icon");
this.iconDeck = iconDeck;
this.currentIcon = iconDeck.values().iterator().next();
}
/**
* Sets the currently shown icon.
*
* @param key
* Icon key.
*/
public void setIcon(T key) {
this.currentIcon = iconDeck.get(key);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.icon.ResizableIcon#setDimension(java.awt.Dimension
* )
*/
public void setDimension(Dimension dim) {
for (ResizableIcon icon : iconDeck.values()) {
int currH = icon.getIconHeight();
int currW = icon.getIconWidth();
if ((currH != dim.height) || (currW != dim.width))
icon.setDimension(dim);
}
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return currentIcon.getIconHeight();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return currentIcon.getIconWidth();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y) {
currentIcon.paintIcon(c, g, x, y);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#addAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
public void addAsynchronousLoadListener(AsynchronousLoadListener l) {
for (ResizableIcon icon : iconDeck.values()) {
if (icon instanceof AsynchronousLoading)
((AsynchronousLoading) icon).addAsynchronousLoadListener(l);
}
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.AsynchronousLoading#isLoading()
*/
public boolean isLoading() {
for (ResizableIcon icon : iconDeck.values()) {
if (icon instanceof AsynchronousLoading) {
if (((AsynchronousLoading) icon).isLoading())
return true;
}
}
return false;
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#removeAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
public void removeAsynchronousLoadListener(AsynchronousLoadListener l) {
for (ResizableIcon icon : iconDeck.values()) {
if (icon instanceof AsynchronousLoading)
((AsynchronousLoading) icon).removeAsynchronousLoadListener(l);
}
}
}
src/org/pushingpixels/flamingo/api/common/icon/ImageWrapperIcon.java 0000644 0001750 0001750 00000021161 11401230444 024720 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.InputStream;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.imageio.ImageIO;
import javax.swing.Icon;
import javax.swing.SwingWorker;
import javax.swing.event.EventListenerList;
import org.pushingpixels.flamingo.api.common.AsynchronousLoadListener;
import org.pushingpixels.flamingo.api.common.AsynchronousLoading;
import org.pushingpixels.flamingo.internal.utils.FlamingoUtilities;
/**
* Helper class to load images and expose them as icons of dynamic size.
*
* @author Kirill Grouchnikov
*/
abstract class ImageWrapperIcon implements Icon, AsynchronousLoading {
/**
* The original image.
*/
protected BufferedImage originalImage;
/**
* The input stream of the original image.
*/
protected InputStream imageInputStream;
/**
* The input stream of the original image.
*/
protected Image image;
/**
* Contains all precomputed images.
*/
protected Map cachedImages;
/**
* The width of the current image.
*/
protected int width;
/**
* The height of the current image.
*/
protected int height;
/**
* The listeners.
*/
protected EventListenerList listenerList = new EventListenerList();
/**
* Create a new image-wrapper icon.
*
* @param inputStream
* The input stream to read the image from.
* @param w
* The width of the icon.
* @param h
* The height of the icon.
*/
public ImageWrapperIcon(InputStream inputStream, int w, int h) {
this.imageInputStream = inputStream;
this.width = w;
this.height = h;
this.listenerList = new EventListenerList();
this.cachedImages = new LinkedHashMap() {
@Override
protected boolean removeEldestEntry(
Map.Entry eldest) {
return size() > 5;
};
};
this.renderImage(this.width, this.height);
}
/**
* Create a new image-wrapper icon.
*
* @param image
* The original image.
* @param w
* The width of the icon.
* @param h
* The height of the icon.
*/
public ImageWrapperIcon(Image image, int w, int h) {
this.imageInputStream = null;
this.image = image;
this.width = w;
this.height = h;
this.listenerList = new EventListenerList();
this.cachedImages = new LinkedHashMap() {
@Override
protected boolean removeEldestEntry(
Map.Entry eldest) {
return size() > 5;
};
};
this.renderImage(this.width, this.height);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#addAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
public void addAsynchronousLoadListener(AsynchronousLoadListener l) {
this.listenerList.add(AsynchronousLoadListener.class, l);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#removeAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
public void removeAsynchronousLoadListener(AsynchronousLoadListener l) {
this.listenerList.remove(AsynchronousLoadListener.class, l);
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return width;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return height;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y) {
BufferedImage image = this.cachedImages.get(this.getIconWidth() + ":"
+ this.getIconHeight());
if (image != null) {
int dx = (this.width - image.getWidth()) / 2;
int dy = (this.height - image.getHeight()) / 2;
g.drawImage(image, x + dx, y + dy, null);
}
}
/**
* Sets the preferred size for this icon. The rendering is
* scheduled automatically.
*
* @param dim
* Preferred size.
*/
public synchronized void setPreferredSize(Dimension dim) {
if ((dim.width == this.width) && (dim.height == this.height))
return;
this.width = dim.width;
this.height = dim.height;
this.renderImage(this.width, this.height);
}
/**
* Renders the image.
*
* @param renderWidth
* Requested rendering width.
* @param renderHeight
* Requested rendering height.
*/
protected synchronized void renderImage(final int renderWidth,
final int renderHeight) {
String key = renderWidth + ":" + renderHeight;
if (this.cachedImages.containsKey(key)) {
fireAsyncCompleted(true);
return;
}
SwingWorker worker = new SwingWorker() {
@Override
protected BufferedImage doInBackground() throws Exception {
if (imageInputStream != null) {
synchronized (imageInputStream) {
if (originalImage == null) {
// read original image
originalImage = ImageIO.read(imageInputStream);
}
}
} else {
GraphicsEnvironment e = GraphicsEnvironment
.getLocalGraphicsEnvironment();
GraphicsDevice d = e.getDefaultScreenDevice();
GraphicsConfiguration c = d.getDefaultConfiguration();
originalImage = c.createCompatibleImage(image
.getWidth(null), image.getHeight(null),
Transparency.TRANSLUCENT);
Graphics g = originalImage.getGraphics();
g.drawImage(image, 0, 0, null);
g.dispose();
}
BufferedImage result = originalImage;
float scaleX = (float) originalImage.getWidth()
/ (float) renderWidth;
float scaleY = (float) originalImage.getHeight()
/ (float) height;
float scale = Math.max(scaleX, scaleY);
if (scale > 1.0f) {
int finalWidth = (int) (originalImage.getWidth() / scale);
result = FlamingoUtilities.createThumbnail(originalImage,
finalWidth);
}
return result;
}
@Override
protected void done() {
try {
BufferedImage bufferedImage = get();
cachedImages.put(renderWidth + ":" + renderHeight,
bufferedImage);
fireAsyncCompleted(true);
} catch (Exception exc) {
fireAsyncCompleted(false);
}
}
};
worker.execute();
}
/**
* Fires the asynchronous load event.
*
* @param event
* Event object.
*/
protected void fireAsyncCompleted(Boolean event) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// 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] == AsynchronousLoadListener.class) {
((AsynchronousLoadListener) listeners[i + 1]).completed(event);
}
}
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.AsynchronousLoading#isLoading()
*/
@Override
public synchronized boolean isLoading() {
BufferedImage image = this.cachedImages.get(this.getIconWidth() + ":"
+ this.getIconHeight());
return (image == null);
}
}
src/org/pushingpixels/flamingo/api/common/icon/FilteredResizableIcon.java 0000644 0001750 0001750 00000010563 11401230444 025740 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.awt.image.BufferedImageOp;
import java.util.LinkedHashMap;
import java.util.Map;
import org.pushingpixels.flamingo.api.common.AsynchronousLoading;
import org.pushingpixels.flamingo.internal.utils.FlamingoUtilities;
/**
* Implementation of {@link ResizableIcon} that allows applying a
* {@link BufferedImageOp} on another icon.
*
* @author Kirill Grouchnikov
*/
public class FilteredResizableIcon implements ResizableIcon {
/**
* Image cache to speed up rendering.
*/
protected Map cachedImages;
/**
* The main (pre-filtered) icon.
*/
protected ResizableIcon delegate;
/**
* Filter operation.
*/
protected BufferedImageOp operation;
/**
* Creates a new filtered icon.
*
* @param delegate
* The main (pre-filtered) icon.
* @param operation
* Filter operation.
*/
public FilteredResizableIcon(ResizableIcon delegate,
BufferedImageOp operation) {
super();
this.delegate = delegate;
this.operation = operation;
this.cachedImages = new LinkedHashMap() {
@Override
protected boolean removeEldestEntry(
java.util.Map.Entry eldest) {
return size() > 5;
}
};
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return delegate.getIconHeight();
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return delegate.getIconWidth();
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.icon.ResizableIcon#setDimension(java.awt.Dimension
* )
*/
public void setDimension(Dimension newDimension) {
delegate.setDimension(newDimension);
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
@Override
public void paintIcon(Component c, Graphics g, int x, int y) {
// check cache
String key = this.getIconWidth() + ":" + this.getIconHeight();
if (!this.cachedImages.containsKey(key)) {
// check if loading
if (this.delegate instanceof AsynchronousLoading) {
AsynchronousLoading asyncDelegate = (AsynchronousLoading) this.delegate;
// if the delegate is still loading - do nothing
if (asyncDelegate.isLoading())
return;
}
BufferedImage offscreen = FlamingoUtilities.getBlankImage(this
.getIconWidth(), this.getIconHeight());
Graphics2D g2d = offscreen.createGraphics();
this.delegate.paintIcon(c, g2d, 0, 0);
g2d.dispose();
BufferedImage filtered = this.operation.filter(offscreen, null);
this.cachedImages.put(key, filtered);
}
g.drawImage(this.cachedImages.get(key), x, y, null);
}
}
src/org/pushingpixels/flamingo/api/common/icon/IcoWrapperResizableIcon.java 0000644 0001750 0001750 00000006525 11401230444 026260 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.Dimension;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
/**
* Implementation of {@link ResizableIcon} interface that wraps ICO files.
*
* @author Kirill Grouchnikov
*/
public class IcoWrapperResizableIcon extends IcoWrapperIcon implements
ResizableIcon {
/**
* Returns the icon for the specified URL.
*
* @param location
* Icon URL.
* @param initialDim
* Initial dimension of the icon.
* @return Icon instance.
*/
public static IcoWrapperResizableIcon getIcon(URL location,
final Dimension initialDim) {
try {
return new IcoWrapperResizableIcon(location.openStream(),
initialDim);
} catch (IOException ioe) {
ioe.printStackTrace();
return null;
}
}
/**
* Returns the icon for the specified input stream.
*
* @param inputStream
* Icon input stream.
* @param initialDim
* Initial dimension of the icon.
* @return Icon instance.
*/
public static IcoWrapperResizableIcon getIcon(InputStream inputStream,
final Dimension initialDim) {
return new IcoWrapperResizableIcon(inputStream, initialDim);
}
/**
* Creates a new ICO-based resizable icon.
*
* @param inputStream
* Input stream with the ICO content.
* @param initialDim
* Initial dimension of the icon.
*/
private IcoWrapperResizableIcon(InputStream inputStream,
Dimension initialDim) {
super(inputStream, initialDim.width, initialDim.height);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.icon.ResizableIcon#setDimension(java.awt.Dimension
* )
*/
public void setDimension(Dimension dim) {
this.setPreferredSize(dim);
}
}
src/org/pushingpixels/flamingo/api/common/icon/ResizableIcon.java 0000644 0001750 0001750 00000004061 11401230444 024255 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.Dimension;
import javax.swing.Icon;
/**
* Interface for icons that have resizability behaviour.
*
* @author Kirill Grouchnikov
*/
public interface ResizableIcon extends Icon {
/**
* Changes the dimension of this icon.
*
* @param newDimension
* New dimension for this icon.
*/
public void setDimension(Dimension newDimension);
}
src/org/pushingpixels/flamingo/api/common/icon/ImageWrapperResizableIcon.java 0000644 0001750 0001750 00000007774 11401230444 026577 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.Dimension;
import java.awt.Image;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
/**
* Implementation of {@link ResizableIcon} interface that wraps image files.
*
* @author Kirill Grouchnikov
*/
public class ImageWrapperResizableIcon extends ImageWrapperIcon implements
ResizableIcon {
/**
* Returns the icon for the specified URL.
*
* @param image
* Image.
* @param initialDim
* Initial dimension of the icon.
* @return Icon instance.
*/
public static ImageWrapperResizableIcon getIcon(Image image,
Dimension initialDim) {
return new ImageWrapperResizableIcon(image, initialDim);
}
/**
* Returns the icon for the specified URL.
*
* @param location
* Icon URL.
* @param initialDim
* Initial dimension of the icon.
* @return Icon instance.
*/
public static ImageWrapperResizableIcon getIcon(URL location,
Dimension initialDim) {
try {
return new ImageWrapperResizableIcon(location.openStream(),
initialDim);
} catch (IOException ioe) {
ioe.printStackTrace();
return null;
}
}
/**
* Returns the icon for the specified input stream.
*
* @param inputStream
* Icon input stream.
* @param initialDim
* Initial dimension of the icon.
* @return Icon instance.
*/
public static ImageWrapperResizableIcon getIcon(InputStream inputStream,
Dimension initialDim) {
return new ImageWrapperResizableIcon(inputStream, initialDim);
}
/**
* Creates a new image-based resizable icon.
*
* @param image
* Image.
* @param initialDim
* Initial dimension of the icon.
*/
private ImageWrapperResizableIcon(Image image, Dimension initialDim) {
super(image, initialDim.width, initialDim.height);
}
/**
* Creates a new image-based resizable icon.
*
* @param inputStream
* Input stream with the image content.
* @param initialDim
* Initial dimension of the icon.
*/
private ImageWrapperResizableIcon(InputStream inputStream,
final Dimension initialDim) {
super(inputStream, initialDim.width, initialDim.height);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.icon.ResizableIcon#setDimension(java.awt.Dimension
* )
*/
public void setDimension(Dimension dim) {
this.setPreferredSize(dim);
}
}
src/org/pushingpixels/flamingo/api/common/icon/EmptyResizableIcon.java 0000644 0001750 0001750 00000006221 11401230444 025274 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
/**
* Implementation of {@link ResizableIcon} that paints nothing.
*
* @author Kirill Grouchnikov
*/
public class EmptyResizableIcon implements ResizableIcon {
/**
* The current icon width.
*/
protected int width;
/**
* The current icon height.
*/
protected int height;
/**
* Creates a new empty resizable icon of the specified size.
*
* @param initialDim
* Initial dimension of the icon.
*/
public EmptyResizableIcon(Dimension initialDim) {
this.width = initialDim.width;
this.height = initialDim.height;
}
/**
* Creates a new empty resizable icon of the specified size.
*
* @param initialDim
* Initial dimension of the icon.
*/
public EmptyResizableIcon(int initialDim) {
this(new Dimension(initialDim, initialDim));
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.icon.ResizableIcon#setDimension(java.awt.Dimension
* )
*/
public void setDimension(Dimension newDimension) {
this.width = newDimension.width;
this.height = newDimension.height;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return this.height;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return this.width;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y) {
}
}
src/org/pushingpixels/flamingo/api/common/icon/IcoWrapperIcon.java 0000644 0001750 0001750 00000047572 11401230444 024426 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common.icon;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.*;
import java.net.URL;
import java.util.*;
import javax.imageio.ImageIO;
import javax.swing.Icon;
import javax.swing.SwingWorker;
import javax.swing.event.EventListenerList;
import org.pushingpixels.flamingo.api.common.AsynchronousLoadListener;
import org.pushingpixels.flamingo.api.common.AsynchronousLoading;
import org.pushingpixels.flamingo.internal.utils.FlamingoUtilities;
/**
* Helper class to load image planes from .ICO files.
*
* @author Kirill Grouchnikov
*/
abstract class IcoWrapperIcon implements Icon, AsynchronousLoading {
/**
* The input stream of the original image.
*/
protected InputStream icoInputStream;
/**
* Image planes of the original ICO image.
*/
protected Map icoPlaneMap;
/**
* Contains all precomputed images.
*/
protected Map cachedImages;
/**
* The width of the current image.
*/
protected int width;
/**
* The height of the current image.
*/
protected int height;
/**
* The listeners.
*/
protected EventListenerList listenerList = new EventListenerList();
/**
* Create a new SVG icon.
*
* @param inputStream
* The input stream to read the SVG document from.
* @param w
* The width of the icon.
* @param h
* The height of the icon.
*/
public IcoWrapperIcon(InputStream inputStream, int w, int h) {
this.icoInputStream = inputStream;
this.width = w;
this.height = h;
this.listenerList = new EventListenerList();
this.cachedImages = new LinkedHashMap() {
@Override
protected boolean removeEldestEntry(
Map.Entry eldest) {
return size() > 5;
};
};
this.renderImage(this.width, this.height);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#addAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
public void addAsynchronousLoadListener(AsynchronousLoadListener l) {
this.listenerList.add(AsynchronousLoadListener.class, l);
}
/*
* (non-Javadoc)
*
* @see
* org.jvnet.flamingo.common.AsynchronousLoading#removeAsynchronousLoadListener
* (org.jvnet.flamingo.common.AsynchronousLoadListener)
*/
public void removeAsynchronousLoadListener(AsynchronousLoadListener l) {
this.listenerList.remove(AsynchronousLoadListener.class, l);
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconWidth()
*/
public int getIconWidth() {
return width;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#getIconHeight()
*/
public int getIconHeight() {
return height;
}
/*
* (non-Javadoc)
*
* @see javax.swing.Icon#paintIcon(java.awt.Component, java.awt.Graphics,
* int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y) {
BufferedImage image = this.cachedImages.get(this.getIconWidth() + ":"
+ this.getIconHeight());
if (image != null) {
int dx = (this.width - image.getWidth()) / 2;
int dy = (this.height - image.getHeight()) / 2;
g.drawImage(image, x + dx, y + dy, null);
}
}
/**
* Sets the preferred size for this icon. The rendering is
* scheduled automatically.
*
* @param dim
* Preferred size.
*/
public synchronized void setPreferredSize(Dimension dim) {
if ((dim.width == this.width) && (dim.height == this.height))
return;
this.width = dim.width;
this.height = dim.height;
this.renderImage(this.width, this.height);
}
/**
* Renders the image.
*
* @param renderWidth
* Requested rendering width.
* @param renderHeight
* Requested rendering height.
*/
protected synchronized void renderImage(final int renderWidth,
final int renderHeight) {
String key = renderWidth + ":" + renderHeight;
if (this.cachedImages.containsKey(key)) {
fireAsyncCompleted(true);
return;
}
SwingWorker worker = new SwingWorker() {
@Override
protected BufferedImage doInBackground() throws Exception {
synchronized (icoInputStream) {
if (icoPlaneMap == null) {
// read original ICO image
Ico ico = new Ico(icoInputStream);
icoPlaneMap = new TreeMap();
Set widths = new HashSet();
for (int i = 0; i < ico.getNumImages(); i++) {
BufferedImage icoPlane = ico.getImage(i);
widths.add(icoPlane.getWidth());
}
for (int width : widths) {
// find the ico plane with the largest color count
BufferedImage bestMatch = null;
int bestColorCount = -1;
for (int i = 0; i < ico.getNumImages(); i++) {
BufferedImage icoPlane = ico.getImage(i);
if (icoPlane.getWidth() != width)
continue;
int icoPlaneColorCount = ico.getNumColors(i);
if (icoPlaneColorCount == 0) {
bestMatch = icoPlane;
bestColorCount = 0;
} else {
if (bestColorCount == 0)
continue;
if (icoPlaneColorCount > bestColorCount) {
bestMatch = icoPlane;
bestColorCount = icoPlaneColorCount;
}
}
}
icoPlaneMap.put(width, bestMatch);
}
}
}
// find the best match
int indexOfBestMatch = -1;
int bestMatchWidth = -1;
for (Map.Entry icoPlaneMapEntry : icoPlaneMap
.entrySet()) {
BufferedImage icoPlane = icoPlaneMapEntry.getValue();
int icoPlaneWidth = icoPlane.getWidth();
if (icoPlaneWidth > renderWidth) {
// check if the ICO plane width is closer
// to the required width than the best match so far
if (bestMatchWidth < 0) {
bestMatchWidth = icoPlaneWidth;
} else {
if (bestMatchWidth > icoPlaneWidth) {
bestMatchWidth = icoPlaneWidth;
}
}
}
}
// if at this point the best match is not found, it
// means that the requested width is bigger than
// any of the ICO planes. Take the biggest ICO plane
// available
if (indexOfBestMatch < 0) {
for (Map.Entry icoPlaneMapEntry : icoPlaneMap
.entrySet()) {
BufferedImage icoPlane = icoPlaneMapEntry.getValue();
int icoPlaneWidth = icoPlane.getWidth();
if (icoPlaneWidth > bestMatchWidth) {
bestMatchWidth = icoPlaneWidth;
}
}
}
BufferedImage bestMatchPlane = icoPlaneMap.get(bestMatchWidth);
BufferedImage result = bestMatchPlane;
float scaleX = (float) bestMatchPlane.getWidth()
/ (float) renderWidth;
float scaleY = (float) bestMatchPlane.getHeight()
/ (float) renderHeight;
float scale = Math.max(scaleX, scaleY);
if (scale > 1.0f) {
int finalWidth = (int) (bestMatchPlane.getWidth() / scale);
result = FlamingoUtilities.createThumbnail(bestMatchPlane,
finalWidth);
}
return result;
}
@Override
protected void done() {
try {
BufferedImage bufferedImage = get();
cachedImages.put(renderWidth + ":" + renderHeight,
bufferedImage);
fireAsyncCompleted(true);
} catch (Exception exc) {
fireAsyncCompleted(false);
}
}
};
worker.execute();
}
/**
* Fires the asynchronous load event.
*
* @param event
* Event object.
*/
protected void fireAsyncCompleted(Boolean event) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// 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] == AsynchronousLoadListener.class) {
((AsynchronousLoadListener) listeners[i + 1]).completed(event);
}
}
}
/*
* (non-Javadoc)
*
* @see org.jvnet.flamingo.common.AsynchronousLoading#isLoading()
*/
@Override
public synchronized boolean isLoading() {
BufferedImage image = this.cachedImages.get(this.getIconWidth() + ":"
+ this.getIconHeight());
return (image == null);
}
}
/**
* The code below is copyrighted by Jeff Friesen and first appeared on InformIT.com at this
* location. This code is licensed under BSD license and can be reused as
* long as the credit is given to Jeff Friesen, InformIT.com and the original
* URL above.
*
* @author Jeff Friesen
*/
class Ico {
private final static int FDE_OFFSET = 6; // first directory entry offset
private final static int DE_LENGTH = 16; // directory entry length
private final static int BMIH_LENGTH = 40; // BITMAPINFOHEADER length
private byte[] icoimage = new byte[0]; // new byte [0] facilitates read()
private int numImages;
private BufferedImage[] bi;
private int[] colorCount;
public Ico(File file) throws BadIcoResException, IOException {
this(file.getAbsolutePath());
}
public Ico(InputStream is) throws BadIcoResException, IOException {
try {
read(is);
parseICOImage();
} finally {
try {
is.close();
} catch (IOException ioe) {
}
}
}
public Ico(String filename) throws BadIcoResException, IOException {
this(new FileInputStream(filename));
}
public Ico(URL url) throws BadIcoResException, IOException {
this(url.openStream());
}
public BufferedImage getImage(int index) {
if (index < 0 || index >= numImages)
throw new IllegalArgumentException("index out of range");
return bi[index];
}
public int getNumColors(int index) {
if (index < 0 || index >= numImages)
throw new IllegalArgumentException("index out of range");
return colorCount[index];
}
public int getNumImages() {
return numImages;
}
private int calcScanlineBytes(int width, int bitCount) {
// Calculate minimum number of double-words required to store width
// pixels where each pixel occupies bitCount bits. XOR and AND bitmaps
// are stored such that each scanline is aligned on a double-word
// boundary.
return (((width * bitCount) + 31) / 32) * 4;
}
private void parseICOImage() throws BadIcoResException, IOException {
// Check resource type field.
if (icoimage[2] != 1 || icoimage[3] != 0)
throw new BadIcoResException("Not an ICO resource");
numImages = ubyte(icoimage[5]);
numImages <<= 8;
numImages |= icoimage[4];
bi = new BufferedImage[numImages];
colorCount = new int[numImages];
for (int i = 0; i < numImages; i++) {
int width = ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH]);
int height = ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 1]);
colorCount[i] = ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 2]);
int bytesInRes = ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 11]);
bytesInRes <<= 8;
bytesInRes |= ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 10]);
bytesInRes <<= 8;
bytesInRes |= ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 9]);
bytesInRes <<= 8;
bytesInRes |= ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 8]);
int imageOffset = ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 15]);
imageOffset <<= 8;
imageOffset |= ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 14]);
imageOffset <<= 8;
imageOffset |= ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 13]);
imageOffset <<= 8;
imageOffset |= ubyte(icoimage[FDE_OFFSET + i * DE_LENGTH + 12]);
if (icoimage[imageOffset] == 40 && icoimage[imageOffset + 1] == 0
&& icoimage[imageOffset + 2] == 0
&& icoimage[imageOffset + 3] == 0) {
// BITMAPINFOHEADER detected
int _width = ubyte(icoimage[imageOffset + 7]);
_width <<= 8;
_width |= ubyte(icoimage[imageOffset + 6]);
_width <<= 8;
_width |= ubyte(icoimage[imageOffset + 5]);
_width <<= 8;
_width |= ubyte(icoimage[imageOffset + 4]);
// If width is 0 (for 256 pixels or higher), _width contains
// actual width.
if (width == 0)
width = _width;
int _height = ubyte(icoimage[imageOffset + 11]);
_height <<= 8;
_height |= ubyte(icoimage[imageOffset + 10]);
_height <<= 8;
_height |= ubyte(icoimage[imageOffset + 9]);
_height <<= 8;
_height |= ubyte(icoimage[imageOffset + 8]);
// If height is 0 (for 256 pixels or higher), _height contains
// actual height times 2.
if (height == 0)
height = _height >> 1; // Divide by 2.
int planes = ubyte(icoimage[imageOffset + 13]);
planes <<= 8;
planes |= ubyte(icoimage[imageOffset + 12]);
int bitCount = ubyte(icoimage[imageOffset + 15]);
bitCount <<= 8;
bitCount |= ubyte(icoimage[imageOffset + 14]);
// If colorCount [i] is 0, the number of colors is determined
// from the planes and bitCount values. For example, the number
// of colors is 256 when planes is 1 and bitCount is 8. Leave
// colorCount [i] set to 0 when planes is 1 and bitCount is 32.
if (colorCount[i] == 0) {
if (planes == 1) {
if (bitCount == 1)
colorCount[i] = 2;
else if (bitCount == 4)
colorCount[i] = 16;
else if (bitCount == 8)
colorCount[i] = 256;
else if (bitCount != 32)
colorCount[i] = (int) Math.pow(2, bitCount);
} else
colorCount[i] = (int) Math.pow(2, bitCount * planes);
}
bi[i] = new BufferedImage(width, height,
BufferedImage.TYPE_INT_ARGB);
// Parse image to image buffer.
int colorTableOffset = imageOffset + BMIH_LENGTH;
if (colorCount[i] == 2) {
int xorImageOffset = colorTableOffset + 2 * 4;
int scanlineBytes = calcScanlineBytes(width, 1);
int andImageOffset = xorImageOffset + scanlineBytes
* height;
int[] masks = { 128, 64, 32, 16, 8, 4, 2, 1 };
for (int row = 0; row < height; row++)
for (int col = 0; col < width; col++) {
int index;
if ((ubyte(icoimage[xorImageOffset + row
* scanlineBytes + col / 8]) & masks[col % 8]) != 0)
index = 1;
else
index = 0;
int rgb = 0;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4
+ 2]));
rgb <<= 8;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4
+ 1]));
rgb <<= 8;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4]));
if ((ubyte(icoimage[andImageOffset + row
* scanlineBytes + col / 8]) & masks[col % 8]) != 0)
bi[i].setRGB(col, height - 1 - row, rgb);
else
bi[i].setRGB(col, height - 1 - row,
0xff000000 | rgb);
}
} else if (colorCount[i] == 16) {
int xorImageOffset = colorTableOffset + 16 * 4;
int scanlineBytes = calcScanlineBytes(width, 4);
int andImageOffset = xorImageOffset + scanlineBytes
* height;
int[] masks = { 128, 64, 32, 16, 8, 4, 2, 1 };
for (int row = 0; row < height; row++)
for (int col = 0; col < width; col++) {
int index;
if ((col & 1) == 0) // even
{
index = ubyte(icoimage[xorImageOffset + row
* scanlineBytes + col / 2]);
index >>= 4;
} else {
index = ubyte(icoimage[xorImageOffset + row
* scanlineBytes + col / 2]) & 15;
}
int rgb = 0;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4
+ 2]));
rgb <<= 8;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4
+ 1]));
rgb <<= 8;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4]));
if ((ubyte(icoimage[andImageOffset + row
* calcScanlineBytes(width, 1) + col / 8]) & masks[col % 8]) != 0)
bi[i].setRGB(col, height - 1 - row, rgb);
else
bi[i].setRGB(col, height - 1 - row,
0xff000000 | rgb);
}
} else if (colorCount[i] == 256) {
int xorImageOffset = colorTableOffset + 256 * 4;
int scanlineBytes = calcScanlineBytes(width, 8);
int andImageOffset = xorImageOffset + scanlineBytes
* height;
int[] masks = { 128, 64, 32, 16, 8, 4, 2, 1 };
for (int row = 0; row < height; row++)
for (int col = 0; col < width; col++) {
int index;
index = ubyte(icoimage[xorImageOffset + row
* scanlineBytes + col]);
int rgb = 0;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4
+ 2]));
rgb <<= 8;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4
+ 1]));
rgb <<= 8;
rgb |= (ubyte(icoimage[colorTableOffset + index * 4]));
if ((ubyte(icoimage[andImageOffset + row
* calcScanlineBytes(width, 1) + col / 8]) & masks[col % 8]) != 0)
bi[i].setRGB(col, height - 1 - row, rgb);
else
bi[i].setRGB(col, height - 1 - row,
0xff000000 | rgb);
}
} else if (colorCount[i] == 0) {
int scanlineBytes = calcScanlineBytes(width, 32);
for (int row = 0; row < height; row++)
for (int col = 0; col < width; col++) {
int rgb = ubyte(icoimage[colorTableOffset + row
* scanlineBytes + col * 4 + 3]);
rgb <<= 8;
rgb |= ubyte(icoimage[colorTableOffset + row
* scanlineBytes + col * 4 + 2]);
rgb <<= 8;
rgb |= ubyte(icoimage[colorTableOffset + row
* scanlineBytes + col * 4 + 1]);
rgb <<= 8;
rgb |= ubyte(icoimage[colorTableOffset + row
* scanlineBytes + col * 4]);
bi[i].setRGB(col, height - 1 - row, rgb);
}
}
} else if (ubyte(icoimage[imageOffset]) == 0x89
&& icoimage[imageOffset + 1] == 0x50
&& icoimage[imageOffset + 2] == 0x4e
&& icoimage[imageOffset + 3] == 0x47
&& icoimage[imageOffset + 4] == 0x0d
&& icoimage[imageOffset + 5] == 0x0a
&& icoimage[imageOffset + 6] == 0x1a
&& icoimage[imageOffset + 7] == 0x0a) {
// PNG detected
ByteArrayInputStream bais;
bais = new ByteArrayInputStream(icoimage, imageOffset,
bytesInRes);
bi[i] = ImageIO.read(bais);
} else
throw new BadIcoResException("BITMAPINFOHEADER or PNG "
+ "expected");
}
icoimage = null; // This array can now be garbage collected.
}
private void read(InputStream is) throws IOException {
int bytesToRead;
while ((bytesToRead = is.available()) != 0) {
byte[] icoimage2 = new byte[icoimage.length + bytesToRead];
System.arraycopy(icoimage, 0, icoimage2, 0, icoimage.length);
is.read(icoimage2, icoimage.length, bytesToRead);
icoimage = icoimage2;
}
}
private int ubyte(byte b) {
return (b < 0) ? 256 + b : b; // Convert byte to unsigned byte.
}
}
class BadIcoResException extends Exception {
public BadIcoResException(String message) {
super(message);
}
}
src/org/pushingpixels/flamingo/api/common/JCommandButtonPanel.java 0000644 0001750 0001750 00000060221 11401230444 024440 0 ustar tony tony /*
* Copyright (c) 2005-2010 Flamingo Kirill Grouchnikov. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of Flamingo Kirill Grouchnikov nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.pushingpixels.flamingo.api.common;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.util.*;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.pushingpixels.flamingo.internal.ui.common.BasicCommandButtonPanelUI;
import org.pushingpixels.flamingo.internal.ui.common.CommandButtonPanelUI;
/**
* Panel that hosts command buttons. Provides support for button groups, single
* selection mode (for toggle command buttons), same icon state / dimension and
* column-fill / row-fill layout.
*
*
* Under the default {@link LayoutKind#ROW_FILL}, the buttons are laid out in
* rows, never exceeding the available horizontal space. A vertical scroll bar
* will kick in once there is not enough vertical space to show all the buttons.
* The schematic below shows a row-fill command button panel:
*
*
*
* +-----------------------------+-+
* | | |
* | +----+ +----+ +----+ +----+ | |
* | | 01 | | 02 | | 03 | | 04 | | |
* | +----+ +----+ +----+ +----+ | |
* | | |
* | +----+ +----+ +----+ +----+ | |
* | | 05 | | 06 | | 07 | | 07 | | |
* | +----+ +----+ +----+ +----+ | |
* | | |
* | +----+ +----+ +----+ +----+ | |
* | | 09 | | 10 | | 11 | | 12 | | |
* | +----+ +----+ +----+ +----+ | |
* | | |
* | +----+ +----+ +----+ +----+ | |
* | | 13 | | 14 | | 15 | | 16 | | |
* +-----------------------------+-+
*
*
*
* Each row hosts four buttons, and the vertical scroll bar allows scrolling the
* content down.
*
*
*
* Under the {@link LayoutKind#COLUMN_FILL}, the buttons are laid out in
* columns, never exceeding the available vertical space. A horizontal scroll
* bar will kick in once there is not enough horizontal space to show all the
* buttons. The schematic below shows a column-fill command button panel:
*
*
*
* +---------------------------------+
* | |
* | +----+ +----+ +----+ +----+ +---|
* | | 01 | | 04 | | 07 | | 10 | | 13|
* | +----+ +----+ +----+ +----+ +---|
* | |
* | +----+ +----+ +----+ +----+ +---|
* | | 02 | | 05 | | 08 | | 11 | | 14|
* | +----+ +----+ +----+ +----+ +---|
* | |
* | +----+ +----+ +----+ +----+ +---|
* | | 03 | | 06 | | 09 | | 12 | | 15|
* | +----+ +----+ +----+ +----+ +---|
* | |
* +---------------------------------+
* +---------------------------------+
*
*
*
* Each column hosts three buttons, and the horizontal scroll bar allows
* scrolling the content down.
*
*
* @author Kirill Grouchnikov
*/
public class JCommandButtonPanel extends JPanel implements Scrollable {
/**
* @see #getUIClassID
*/
public static final String uiClassID = "CommandButtonPanelUI";
/**
* List of titles for all button groups.
*
* @see #getGroupCount()
* @see #getGroupTitleAt(int)
*/
protected List groupTitles;
/**
* List of all button groups.
*
* @see #getGroupCount()
* @see #getGroupButtons(int)
*/
protected List> buttons;
/**
* Maximum number of columns for this panel. Relevant only when the layout
* kind is {@link LayoutKind#ROW_FILL}.
*
* @see #getMaxButtonColumns()
* @see #setMaxButtonColumns(int)
*/
protected int maxButtonColumns;
/**
* Maximum number of rows for this panel. Relevant only when the layout kind
* is {@link LayoutKind#COLUMN_FILL}.
*
* @see #getMaxButtonRows()
* @see #setMaxButtonRows(int)
*/
protected int maxButtonRows;
/**
* Indicates the selection mode for the {@link JCommandToggleButton} in this
* panel.
*
* @see #setSingleSelectionMode(boolean)
*/
protected boolean isSingleSelectionMode;
/**
* If true, the panel will show group labels.
*
* @see #setToShowGroupLabels(boolean)
* @see #isToShowGroupLabels()
*/
protected boolean toShowGroupLabels;
/**
* The button group for the single selection mode.
*/
protected CommandToggleButtonGroup buttonGroup;
/**
* Current icon dimension.
*/
protected int currDimension;
/**
* Current icon state.
*/
protected CommandButtonDisplayState currState;
/**
* Layout kind of this button panel.
*
* @see #getLayoutKind()
* @see #setLayoutKind(LayoutKind)
*/
protected LayoutKind layoutKind;
/**
* Enumerates the available layout kinds.
*
* @author Kirill Grouchnikov
*/
public enum LayoutKind {
/**
* The buttons are layed out in rows respecting the available width.
*/
ROW_FILL,
/**
* The buttons are layed out in columns respecting the available height.
*/
COLUMN_FILL
}
/**
* Creates a new panel.
*/
protected JCommandButtonPanel() {
this.buttons = new ArrayList>();
this.groupTitles = new ArrayList();
this.maxButtonColumns = -1;
this.maxButtonRows = -1;
this.isSingleSelectionMode = false;
this.toShowGroupLabels = true;
this.setLayoutKind(LayoutKind.ROW_FILL);
}
/**
* Creates a new panel.
*
* @param startingDimension
* Initial dimension for buttons.
*/
public JCommandButtonPanel(int startingDimension) {
this();
this.currDimension = startingDimension;
this.currState = CommandButtonDisplayState.FIT_TO_ICON;
this.updateUI();
}
/**
* Creates a new panel.
*
* @param startingState
* Initial state for buttons.
*/
public JCommandButtonPanel(CommandButtonDisplayState startingState) {
this();
this.currDimension = -1;
this.currState = startingState;
this.updateUI();
}
/**
* Adds a new button group at the specified index.
*
* @param buttonGroupName
* Button group name.
* @param groupIndex
* Button group index.
* @see #addButtonGroup(String)
* @see #removeButtonGroup(String)
* @see #removeAllGroups()
*/
public void addButtonGroup(String buttonGroupName, int groupIndex) {
this.groupTitles.add(groupIndex, buttonGroupName);
List list = new ArrayList();
this.buttons.add(groupIndex, list);
this.fireStateChanged();
}
/**
* Adds a new button group after all the existing button groups.
*
* @param buttonGroupName
* Button group name.
* @see #addButtonGroup(String, int)
* @see #removeButtonGroup(String)
* @see #removeAllGroups()
*/
public void addButtonGroup(String buttonGroupName) {
this.addButtonGroup(buttonGroupName, this.groupTitles.size());
}
/**
* Removes the specified button group.
*
* @param buttonGroupName
* Name of the button group to remove.
* @see #addButtonGroup(String)
* @see #addButtonGroup(String, int)
* @see #removeAllGroups()
*/
public void removeButtonGroup(String buttonGroupName) {
int groupIndex = this.groupTitles.indexOf(buttonGroupName);
if (groupIndex < 0)
return;
this.groupTitles.remove(groupIndex);
List list = this.buttons.get(groupIndex);
if (list != null) {
for (AbstractCommandButton button : list) {
this.remove(button);
if (this.isSingleSelectionMode
&& (button instanceof JCommandToggleButton)) {
this.buttonGroup.remove((JCommandToggleButton) button);
}
}
}
this.buttons.remove(groupIndex);
this.fireStateChanged();
}
/**
* Adds a new button to the specified button group.
*
* @param commandButton
* Button to add.
* @return Returns the index of the button on the specified group, or -1 if
* no such group exists.
* @see #addButtonToGroup(String, AbstractCommandButton)
* @see #addButtonToGroup(String, int, AbstractCommandButton)
* @see #removeButtonFromGroup(String, int)
*/
public int addButtonToLastGroup(AbstractCommandButton commandButton) {
if (this.groupTitles.size() == 0)
return -1;
int groupIndex = this.groupTitles.size() - 1;
commandButton.setDisplayState(this.currState);
return this.addButtonToGroup(this.groupTitles.get(groupIndex),
this.buttons.get(groupIndex).size(), commandButton);
}
/**
* Adds a new button to the specified button group.
*
* @param buttonGroupName
* Name of the button group.
* @param commandButton
* Button to add.
* @return Returns the index of the button on the specified group, or -1 if
* no such group exists.
* @see #addButtonToGroup(String, int, AbstractCommandButton)
* @see #addButtonToLastGroup(AbstractCommandButton)
* @see #removeButtonFromGroup(String, int)
*/
public int addButtonToGroup(String buttonGroupName,
AbstractCommandButton commandButton) {
int groupIndex = this.groupTitles.indexOf(buttonGroupName);
if (groupIndex < 0)
return -1;
commandButton.setDisplayState(this.currState);
return this.addButtonToGroup(buttonGroupName, this.buttons.get(
groupIndex).size(), commandButton);
}
/**
* Adds a new button to the specified button group.
*
* @param buttonGroupName
* Name of the button group.
* @param indexInGroup
* Index of the button in group.
* @param commandButton
* Button to add.
* @return Returns the index of the button on the specified group, or -1 if
* no such group exists.
* @see #addButtonToGroup(String, int, AbstractCommandButton)
* @see #addButtonToLastGroup(AbstractCommandButton)
* @see #removeButtonFromGroup(String, int)
*/
public int addButtonToGroup(String buttonGroupName, int indexInGroup,
AbstractCommandButton commandButton) {
int groupIndex = this.groupTitles.indexOf(buttonGroupName);
if (groupIndex < 0)
return -1;
// commandButton.setState(ElementState.ORIG, true);
this.add(commandButton);
this.buttons.get(groupIndex).add(indexInGroup, commandButton);
if (this.isSingleSelectionMode
&& (commandButton instanceof JCommandToggleButton)) {
this.buttonGroup.add((JCommandToggleButton) commandButton);
}
this.fireStateChanged();
return indexInGroup;
}
/**
* Removes the button at the specified index from the specified button
* group.
*
* @param buttonGroupName
* Name of the button group.
* @param indexInGroup
* Index of the button to remove.
* @see #addButtonToGroup(String, AbstractCommandButton)
* @see #addButtonToGroup(String, int, AbstractCommandButton)
* @see #addButtonToLastGroup(AbstractCommandButton)
*/
public void removeButtonFromGroup(String buttonGroupName, int indexInGroup) {
int groupIndex = this.groupTitles.indexOf(buttonGroupName);
if (groupIndex < 0)
return;
AbstractCommandButton removed = this.buttons.get(groupIndex).remove(
indexInGroup);
this.remove(removed);
if (this.isSingleSelectionMode
&& (removed instanceof JCommandToggleButton)) {
this.buttonGroup.remove((JCommandToggleButton) removed);
}
this.fireStateChanged();
}
/**
* Removes all the button groups and buttons from this panel.
*
* @see #addButtonGroup(String, int)
* @see #addButtonGroup(String)
* @see #removeButtonGroup(String)
* @see #removeButtonFromGroup(String, int)
*/
public void removeAllGroups() {
for (List