org.eclipse.wst.jsdt.ui.wizards
Class ClasspathAttributeConfiguration

java.lang.Object
  extended by org.eclipse.wst.jsdt.ui.wizards.ClasspathAttributeConfiguration

public abstract class ClasspathAttributeConfiguration
extends java.lang.Object

A ClasspathAttributeConfiguration specifies how a class path attribute is presented and configured in the JavaScript build path dialog.

Clients should implement this interface and include the name of their class in an extension contributed to the jdt.ui's classpath attribute configuration extension point (named org.eclipse.wst.jsdt.ui.classpathAttributeConfiguration ).

Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Nested Class Summary
static class ClasspathAttributeConfiguration.ClasspathAttributeAccess
          This class provides information about the attribute to be rendered or configured.
 
Constructor Summary
ClasspathAttributeConfiguration()
           
 
Method Summary
abstract  boolean canEdit(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          Specifies if the given attribute can be edited.
abstract  boolean canRemove(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          Specifies if 'Remove' is a valid action on the given attribute.
abstract  ImageDescriptor getImageDescriptor(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          Returns the image descriptor of the classpath attributes name as a translated string.
abstract  java.lang.String getNameLabel(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          Returns the label of the classpath attributes name as a translated string.
abstract  java.lang.String getValueLabel(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          Returns the label of the classpath attributes value as a translated string.
abstract  IIncludePathAttribute performEdit(Shell shell, ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          This method is invoked when the Edit is pressed.
abstract  IIncludePathAttribute performRemove(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
          This method is invoked when the Remove is pressed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClasspathAttributeConfiguration

public ClasspathAttributeConfiguration()
Method Detail

getImageDescriptor

public abstract ImageDescriptor getImageDescriptor(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
Returns the image descriptor of the classpath attributes name as a translated string.

Parameters:
attribute - access to the attributes to render
Returns:
returns the label value of the value

getNameLabel

public abstract java.lang.String getNameLabel(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
Returns the label of the classpath attributes name as a translated string.

Parameters:
attribute - access to the attributes to render
Returns:
returns the label value of the value

getValueLabel

public abstract java.lang.String getValueLabel(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
Returns the label of the classpath attributes value as a translated string.

Parameters:
attribute - access to the attributes to render
Returns:
returns the label value of the value

canEdit

public abstract boolean canEdit(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
Specifies if the given attribute can be edited. This will enable the Edit button that typically shows the edit dialog.

Parameters:
attribute - access to the attribute to answer the question of
Returns:
returns true if the attribute can be edited.

canRemove

public abstract boolean canRemove(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
Specifies if 'Remove' is a valid action on the given attribute. This will enable the Remove button. The action will typically clear the attributes value. The method should only return true if the element isn't already cleared.

Parameters:
attribute - access to the attribute to answer the question of
Returns:
returns true if the attribute can be edited.

performEdit

public abstract IIncludePathAttribute performEdit(Shell shell,
                                                  ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
This method is invoked when the Edit is pressed. The method is expected to show a configuration dialog.

Parameters:
shell - the parent shell
attribute - access to the attribute to configure
Returns:
returns the configured attribute or null if the action has been cancelled.

performRemove

public abstract IIncludePathAttribute performRemove(ClasspathAttributeConfiguration.ClasspathAttributeAccess attribute)
This method is invoked when the Remove is pressed. The method should not show a dialog.

Parameters:
attribute - access to the attribute to configure
Returns:
returns the configured attribute