org.netbeans.modules.refactoring.spi.ui

Annotation Type ScopeProvider.Registration

@Target(value=TYPE)
 @Retention(value=SOURCE)
public static @interface ScopeProvider.Registration

Declarative registration of a ScopeProvider implementation. By marking the implementation class with this annotation, you automatically register that implementation. The class must be public and have a public constructor which takes no arguments.

Since:

1.30

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	displayName Display name.
String	id The unique ID of the scope description.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	iconBase Path to image representing the scope's icon.
int	position Position in the location.

Element Detail

id

public abstract String id

The unique ID of the scope description.

Returns:

unique id

displayName

public abstract String displayName

Display name. Usually prefixed with '#' to reference value from a Bundle.properties file in the same package.

Returns:

display name for the scope

position

public abstract int position

Position in the location. Negative numbers can be used for scopes that should be higher in the list, but not selected by default.

Default:

2147483647

iconBase

public abstract String iconBase

Path to image representing the scope's icon.

Returns:

"org/myproject/mypkg/Icon.png"

Default:

""