/**
* Copyright (c) 2002-2010 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM - Initial API and implementation
*/
package org.eclipse.emf.common.ui;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.ContentViewer;
import org.eclipse.jface.viewers.IBaseLabelProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CLabel;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.SashForm;
import org.eclipse.swt.custom.ViewForm;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.events.MouseAdapter;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.MouseListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.ui.IPartListener;
import org.eclipse.ui.IPropertyListener;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
/**
* Please don't use this class until the design is complete.
*/
public abstract class ViewerPane implements IPropertyListener, Listener
{
private static final long serialVersionUID = 1L;
protected IWorkbenchPage page;
protected IWorkbenchPart part;
protected Collection<Object> buddies = new ArrayList<Object>();
protected Viewer viewer;
protected Composite container;
boolean isActive;
protected CLabel titleLabel;
protected ToolBar actionBar;
protected ToolBarManager toolBarManager;
protected MenuManager menuManager;
protected Image pullDownImage;
protected ToolBar systemBar;
protected ViewForm control;
protected MouseListener mouseListener =
new MouseAdapter()
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
public void mouseDown(MouseEvent e)
{
requestActivation();
}
@Override
public void mouseDoubleClick(MouseEvent e)
{
if (e.getSource() == titleLabel)
{
doMaximize();
}
}
};
protected IPartListener partListener =
new IPartListener()
{
public void partActivated(IWorkbenchPart p)
{
// Do nothing
}
public void partBroughtToTop(IWorkbenchPart p)
{
// Do nothing
}
public void partClosed(IWorkbenchPart p)
{
// Do nothing
}
public void partDeactivated(IWorkbenchPart p)
{
if (p == ViewerPane.this.part)
{
showFocus(false);
}
}
public void partOpened(IWorkbenchPart p)
{
// Do nothing
}
};
/**
* Constructs a view pane for a view part.
*/
public ViewerPane(IWorkbenchPage page, IWorkbenchPart part)
{
WorkbenchColors.startup();
this.page = page;
this.part = part;
page.addPartListener(partListener);
}
abstract public Viewer createViewer(Composite parent);
public Collection<Object> getBudies()
{
return buddies;
}
public void createControl(Composite parent)
{
if (getControl() == null)
{
container = parent;
// Create view form.
//control = new ViewForm(parent, getStyle());
control = new ViewForm(parent, SWT.NONE);
control.addDisposeListener
(new DisposeListener()
{
/**
*
*/
private static final long serialVersionUID = 1L;
public void widgetDisposed(DisposeEvent event)
{
dispose();
}
});
control.marginWidth = 0;
control.marginHeight = 0;
// Create a title bar.
createTitleBar();
viewer = createViewer(control);
control.setContent(viewer.getControl());
control.setTabList(new Control [] { viewer.getControl() });
// When the pane or any child gains focus, notify the workbench.
control.addListener(SWT.Activate, this);
hookFocus(control);
hookFocus(viewer.getControl());
}
}
public Viewer getViewer()
{
return viewer;
}
/**
* Get the control.
*/
public Control getControl()
{
return control;
}
/**
* Get the view form.
*/
protected ViewForm getViewForm()
{
return control;
}
/**
* @see Listener
*/
public void handleEvent(Event event)
{
if (event.type == SWT.Activate)
{
requestActivation();
}
}
/**
* Hook focus on a control.
*/
public void hookFocus(Control ctrl)
{
ctrl.addMouseListener(mouseListener);
}
/**
* Notify the workbook page that the part pane has
* been activated by the user.
*/
protected void requestActivation()
{
control.getContent().setFocus();
showFocus(true);
}
/**
* Sets focus to this part.
*/
public void setFocus()
{
requestActivation();
control.getContent().setFocus();
}
/**
* Tool bar manager
*/
class PaneToolBarManager extends ToolBarManager
{
/**
*
*/
private static final long serialVersionUID = 1L;
public PaneToolBarManager(ToolBar paneToolBar)
{
super(paneToolBar);
}
/**
* EATM I have no idea how this is supposed to be called.
*/
@Override
protected void relayout(ToolBar toolBar, int oldCount, int newCount)
{
// remove/add the action bar from the view so to avoid
// having an empty action bar participating in the view's
// layout calculation (and maybe causing an empty bar to appear)
if (newCount < 1)
{
if (control.getTopCenter() != null)
{
control.setTopCenter(null);
}
}
else
{
toolBar.layout();
if (control.getTopCenter() == null)
{
control.setTopCenter(toolBar);
}
}
Composite parent= toolBar.getParent();
parent.layout();
if (parent.getParent() != null)
{
parent.getParent().layout();
}
}
}
/**
* Create the menu manager.
*/
private void createMenuManager()
{
menuManager = new MenuManager("Pane Menu");
if (systemBar != null)
{
createPulldownMenu();
}
}
/**
* Create a pull-down menu on the action bar.
*/
private void createPulldownMenu()
{
if (systemBar != null)
{
ToolItem ti = new ToolItem(systemBar, SWT.PUSH, 0);
try
{
pullDownImage =
ImageDescriptor.createFromURL
(new URL(CommonUIPlugin.INSTANCE.getImage("full/ctool16/ViewPullDown").toString())).createImage();
ti.setImage(pullDownImage);
ti.addSelectionListener
(new SelectionAdapter()
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
public void widgetSelected(SelectionEvent e)
{
showViewMenu();
}
});
}
catch (MalformedURLException exception)
{
// Do nothing
}
}
}
/**
* Create a title bar for the pane which includes
* the view icon and title to the far left, and
* the close X icon to the far right.
* The middle part is reserved for the view part to
* add a menu and tools.
*/
protected void createTitleBar()
{
// Only do this once.
if (titleLabel == null)
{
// Title.
titleLabel = new CLabel(control, SWT.SHADOW_NONE);
hookFocus(titleLabel);
titleLabel.setAlignment(SWT.LEFT);
titleLabel.addMouseListener
(new MouseAdapter()
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
public void mouseDown(MouseEvent e)
{
if (e.button == 3)
{
showTitleLabelMenu(e);
}
}
});
updateTitles();
control.setTopLeft(titleLabel);
// Listen to title changes.
// getViewPart().addPropertyListener(this);
// Action bar.
actionBar = new ToolBar(control, SWT.FLAT | SWT.WRAP);
hookFocus(actionBar);
control.setTopCenter(actionBar);
// System bar.
systemBar = new ToolBar(control, SWT.FLAT | SWT.WRAP);
hookFocus(systemBar);
if (menuManager != null && !menuManager.isEmpty())
{
createPulldownMenu();
}
control.setTopRight(systemBar);
}
}
protected void doMaximize()
{
Control child = control;
for (Control parent = control.getParent(); parent instanceof SashForm || parent instanceof CTabFolder; parent = parent.getParent())
{
if (parent instanceof CTabFolder)
{
CTabFolder cTabFolder = (CTabFolder)parent;
cTabFolder.setMaximized(!cTabFolder.getMaximized());
}
else if (parent instanceof SashForm)
{
SashForm sashForm = (SashForm)parent;
if (sashForm.getMaximizedControl() == null)
{
sashForm.setMaximizedControl(child);
}
else
{
sashForm.setMaximizedControl(null);
}
}
child = parent;
}
}
public void dispose()
{
if ((control != null) && (!control.isDisposed()))
{
control.removeListener(SWT.Activate, this);
control = null;
page.removePartListener(partListener);
}
if (pullDownImage != null)
{
pullDownImage.dispose();
pullDownImage = null;
}
}
public MenuManager getMenuManager()
{
if (menuManager == null)
{
createMenuManager();
}
return menuManager;
}
public ToolBarManager getToolBarManager()
{
if (toolBarManager == null)
{
toolBarManager = new PaneToolBarManager(actionBar);
}
return toolBarManager;
}
/**
* Indicates that a property has changed.
*
* @param source the object whose property has changed
* @param propID the ID of the property which has changed; property IDs
* are generally defined as constants on the source class
*/
public void propertyChanged(Object source, int propID)
{
if (propID == IWorkbenchPart.PROP_TITLE)
{
updateTitles();
}
}
/**
* Indicate focus in part.
*/
public void showFocus(boolean inFocus)
{
if (inFocus != isActive)
{
isActive = inFocus;
if (titleLabel != null)
{
if (inFocus)
{
//titleLabel.setBackground(WorkbenchColors.getActiveGradient(), WorkbenchColors.getActiveGradientPercents());
// titleLabel.setForeground(titleLabel.getDisplay().getSystemColor(SWT.COLOR_TITLE_FOREGROUND));
titleLabel.update();
titleLabel.redraw();
//actionBar.setBackground(WorkbenchColors.getActiveGradientEnd());
//systemBar.setBackground(WorkbenchColors.getActiveGradientEnd());
}
else
{
//titleLabel.setBackground(null, null);
// titleLabel.setForeground(null);
titleLabel.update();
titleLabel.redraw();
//actionBar.setBackground(WorkbenchColors.getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
//systemBar.setBackground(WorkbenchColors.getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
}
}
}
}
/**
* Show the context menu for this window.
*/
private void showViewMenu()
{
Menu aMenu = menuManager.createContextMenu(getControl());
Point topLeft = new Point(0, 0);
topLeft.y += systemBar.getBounds().height;
topLeft = systemBar.toDisplay(topLeft);
aMenu.setLocation(topLeft.x, topLeft.y);
aMenu.setVisible(true);
}
@Override
public String toString()
{
String label = "disposed";
if((titleLabel != null) && (!titleLabel.isDisposed()))
label = titleLabel.getText();
return getClass().getName() + "@" + Integer.toHexString(hashCode()) +
"(" + label + ")";
}
public void updateActionBars()
{
if (menuManager != null)
{
menuManager.updateAll(false);
}
if (toolBarManager != null)
{
getToolBarManager().update(false);
}
}
/**
* Update the title attributes.
*/
public void updateTitles()
{
// IViewPart view = getViewPart();
// titleLabel.setText(view.getTitle());
// titleLabel.setImage(view.getTitleImage());
titleLabel.update();
}
public void setTitle(Object object)
{
if (viewer != null)
{
if (viewer instanceof ContentViewer)
{
IBaseLabelProvider labelProvider = ((ContentViewer)viewer).getLabelProvider();
if (labelProvider instanceof ILabelProvider)
{
if (object == null)
{
titleLabel.setImage(null);
titleLabel.setText("");
}
else
{
titleLabel.setImage(((ILabelProvider)labelProvider).getImage(object));
titleLabel.setText(((ILabelProvider)labelProvider).getText(object));
}
}
}
}
}
public void setTitle(String title, Image image)
{
if (titleLabel != null)
{
titleLabel.setImage(image);
titleLabel.setText(title);
}
}
private void showTitleLabelMenu(MouseEvent e)
{
Menu menu = new Menu(titleLabel);
boolean isMaximized =
control.getParent() instanceof SashForm ?
((SashForm)control.getParent()).getMaximizedControl() != null :
control.getParent() instanceof CTabFolder && ((CTabFolder)control.getParent()).getMaximized();
MenuItem restoreItem = new MenuItem(menu, SWT.NONE);
restoreItem.setText(CommonUIPlugin.INSTANCE.getString("_UI_Restore_menu_item"));
restoreItem.addSelectionListener
(new SelectionAdapter()
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
public void widgetSelected(SelectionEvent selectionEvent)
{
doMaximize();
}
});
restoreItem.setEnabled(isMaximized);
MenuItem maximizeItem = new MenuItem(menu, SWT.NONE);
maximizeItem.setText(CommonUIPlugin.INSTANCE.getString("_UI_Maximize_menu_item"));
maximizeItem.addSelectionListener
(new SelectionAdapter()
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
public void widgetSelected(SelectionEvent selectionEvent)
{
doMaximize();
}
});
maximizeItem.setEnabled(!isMaximized);
Point point = new Point(e.x, e.y);
point = titleLabel.toDisplay(point);
menu.setLocation(point.x, point.y);
menu.setVisible(true);
}
}
/**
* EATM I just ripped this off and it's still a big mess.
*
* This class manages the common workbench colors.
*/
class WorkbenchColors
{
static private boolean init = false;
static private Map<Object, Color> colorMap;
static private Color [] activeGradient;
static private int [] activePercentages;
final static private String CLR_GRAD_START = "clrGradStart";
final static private String CLR_GRAD_MID = "clrGradMid";
final static private String CLR_GRAD_END = "clrGradEnd";
/**
* Returns the active gradient.
*/
static public Color [] getActiveGradient() {
return activeGradient;
}
/**
* Returns the active gradient start color.
*/
static public Color getActiveGradientStart() {
Color clr = colorMap.get(CLR_GRAD_START);
return clr;
}
/**
* Returns the active gradient end color.
*/
static public Color getActiveGradientEnd() {
Color clr = colorMap.get(CLR_GRAD_END);
return clr;
}
/**
* Returns the active gradient percents.
*/
static public int [] getActiveGradientPercents() {
return activePercentages;
}
/**
* Returns a color identified by an RGB value.
*/
static public Color getColor(RGB rgbValue) {
Color clr = colorMap.get(rgbValue);
if (clr == null) {
Display disp = Display.getDefault();
clr = new Color(disp, rgbValue);
colorMap.put(rgbValue, clr);
}
return clr;
}
/**
* Returns a system color identified by a SWT constant.
*/
static public Color getSystemColor(int swtId) {
Integer bigInt = swtId;
Color clr = colorMap.get(bigInt);
if (clr == null) {
Display disp = Display.getDefault();
clr = disp.getSystemColor(swtId);
colorMap.put(bigInt, clr);
}
return clr;
}
/**
* Disposes of the colors.
*/
static public void shutdown() {
if (!init)
return;
for (Color color : colorMap.values())
{
color.dispose();
}
colorMap.clear();
gradient.dispose();
}
/**
* Initializes the colors.
*/
static public void startup() {
if (init)
return;
init = true;
Display disp = Display.getDefault();
colorMap = new HashMap<Object, Color>(10);
// Define gradient (blue to widget background color)
Color clr1 = disp.getSystemColor(SWT.COLOR_TITLE_BACKGROUND);
Color clr2 = disp.getSystemColor(SWT.COLOR_TITLE_BACKGROUND_GRADIENT);
Color clr3 = disp.getSystemColor(SWT.COLOR_WIDGET_BACKGROUND);
int r = clr1.getRGB().red + 2 * (clr3.getRGB().red - clr1.getRGB().red) / 3;
r = (clr3.getRGB().red > clr1.getRGB().red) ? Math.min(r, clr3.getRGB().red) : Math.max(r, clr3.getRGB().red);
int g = clr1.getRGB().green + 2 * (clr3.getRGB().green - clr1.getRGB().green) / 3;
g = (clr3.getRGB().green > clr1.getRGB().green) ? Math.min(g, clr3.getRGB().green) : Math.max(g, clr3.getRGB().green);
int b = clr1.getRGB().blue + 2 * (clr3.getRGB().blue - clr1.getRGB().blue) / 3;
b = (clr3.getRGB().blue > clr1.getRGB().blue) ? Math.min(b, clr3.getRGB().blue) : Math.max(b, clr3.getRGB().blue);
Color clr4 = new Color(disp, r, g, b);
// colorMap.put(CLR_GRAD_START, clr1);
colorMap.put(CLR_GRAD_START, clr4);
colorMap.put(CLR_GRAD_MID, clr2);
colorMap.put(CLR_GRAD_END, clr3);
activeGradient = new Color [] { clr4, clr3, clr3 };
activePercentages = new int[] {25, 100};
// Preload.
getSystemColor(SWT.COLOR_WIDGET_FOREGROUND);
getSystemColor(SWT.COLOR_WIDGET_BACKGROUND);
}
protected static Image gradient;
protected static Image mirrorGradient;
public static Image getGradient()
{
return getGradient(true);
}
public static Image getGradient(boolean leftToRight)
{
if (leftToRight)
{
if (gradient == null)
{
gradient = createGradient(true);
}
return gradient;
}
else
{
if (mirrorGradient == null)
{
mirrorGradient = createGradient(false);
}
return mirrorGradient;
}
}
protected static Image createGradient(boolean leftToRight)
{
int width = 20;
Display display = Display.getDefault();
Color startColor = display.getSystemColor(leftToRight ? SWT.COLOR_WIDGET_BACKGROUND : SWT.COLOR_TITLE_BACKGROUND);
RGB rgb1 = startColor.getRGB();
Color endColor = display.getSystemColor(leftToRight ? SWT.COLOR_TITLE_BACKGROUND : SWT.COLOR_WIDGET_BACKGROUND);
RGB rgb2 = endColor.getRGB();
for (int k = 0; k < width; k++)
{
int r = rgb1.red + k * (rgb2.red - rgb1.red) / width;
r = (rgb2.red > rgb1.red) ? Math.min(r, rgb2.red) : Math.max(r, rgb2.red);
int g = rgb1.green + k * (rgb2.green - rgb1.green) / width;
g = (rgb2.green > rgb1.green) ? Math.min(g, rgb2.green) : Math.max(g, rgb2.green);
int b = rgb1.blue + k * (rgb2.blue - rgb1.blue) / width;
b = (rgb2.blue > rgb1.blue) ? Math.min(b, rgb2.blue) : Math.max(b, rgb2.blue);
Color color = new Color(display, r, g, b);
color.dispose();
}
return Display.getCurrent().getSystemImage(SWT.ICON_ERROR);
}
}