/*******************************************************************************
* Copyright (c) 2000, 2006 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 Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.internal.decorators;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtension;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ui.internal.dialogs.DialogUtil;
import org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants;
import org.eclipse.ui.model.IWorkbenchAdapter;
import org.eclipse.ui.plugin.AbstractUIPlugin;
/**
* Represent the description of an action within
* an action set. It does not create an action.
*
* [Issue: This class overlaps with ActionDescriptor
* and should be reviewed to determine if code
* reuse if possible.]
*/
public class LightweightActionDescriptor implements IAdaptable,
IWorkbenchAdapter {
private static final Object[] NO_CHILDREN = new Object[0];
private String id;
private String label;
private String description;
private ImageDescriptor image;
/**
* Create a new instance of <code>LightweightActionDescriptor</code>.
*
* @param actionElement the configuration element
*/
public LightweightActionDescriptor(IConfigurationElement actionElement) {
super();
this.id = actionElement.getAttribute(IWorkbenchRegistryConstants.ATT_ID);
this.label = actionElement.getAttribute(IWorkbenchRegistryConstants.ATT_LABEL);
this.description = actionElement
.getAttribute(IWorkbenchRegistryConstants.TAG_DESCRIPTION);
String iconName = actionElement.getAttribute(IWorkbenchRegistryConstants.ATT_ICON);
if (iconName != null) {
IExtension extension = actionElement.getDeclaringExtension();
this.image = AbstractUIPlugin.imageDescriptorFromPlugin(extension
.getNamespace(), iconName);
}
}
/**
* Returns an object which is an instance of the given class
* associated with this object. Returns <code>null</code> if
* no such object can be found.
*/
public Object getAdapter(Class adapter) {
if (adapter == IWorkbenchAdapter.class) {
return this;
}
return null;
}
/**
* Returns the action's description.
*
* @return the description
*/
public String getDescription() {
return description;
}
/**
* Returns the action's id.
*
* @return the id
*/
public String getId() {
return id;
}
/**
* Returns the action's image descriptor.
*
* @return the image descriptor
*/
public ImageDescriptor getImageDescriptor() {
return image;
}
/* (non-Javadoc)
* @see org.eclipse.ui.model.IWorkbenchAdapter#getImageDescriptor(java.lang.Object)
*/
public ImageDescriptor getImageDescriptor(Object o) {
if (o == this) {
return getImageDescriptor();
}
return null;
}
/**
* Returns the action's label.
*
* @return the label
*/
public String getLabel() {
return label;
}
/* (non-Javadoc)
* @see org.eclipse.ui.model.IWorkbenchAdapter#getLabel(java.lang.Object)
*/
public String getLabel(Object o) {
if (o == this) {
String text = getLabel();
int end = text.lastIndexOf('@');
if (end >= 0) {
text = text.substring(0, end);
}
return DialogUtil.removeAccel(text);
}
return o == null ? "" : o.toString();//$NON-NLS-1$
}
/* (non-Javadoc)
* @see org.eclipse.ui.model.IWorkbenchAdapter#getChildren(java.lang.Object)
*/
public Object[] getChildren(Object o) {
return NO_CHILDREN;
}
/* (non-Javadoc)
* @see org.eclipse.ui.model.IWorkbenchAdapter#getParent(java.lang.Object)
*/
public Object getParent(Object o) {
return null;
}
}