org.openide.windows

Annotation Type TopComponent.Description

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public static @interface TopComponent.Description

Provides basic information about the persistence of a TopComponent. Using this annotation is preferred to overriding TopComponent.Description.preferredID(), TopComponent.getPersistenceType(), or TopComponent.getIcon(), or calling TopComponent.setIcon(java.awt.Image).

Since:

6.37

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	preferredID The default value for TopComponent.preferredID().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	iconBase The icon to load for TopComponent.getIcon().
int	persistenceType Default value for TopComponent.getPersistenceType().

Element Detail

preferredID

public abstract String preferredID

The default value for TopComponent.preferredID(). It can consist only of upper and lower case letters, digits and '-' or '_' characters. If the TopCopmponent is a singleton then you can use this id to lookup the TopComponent in WindowManager.findTopComponent(java.lang.String)

iconBase

public abstract String iconBase

The icon to load for TopComponent.getIcon().

Default:

""

persistenceType

public abstract int persistenceType

Default value for TopComponent.getPersistenceType().

Returns:

one of TopComponent.PERSISTENCE_ALWAYS, TopComponent.PERSISTENCE_NEVER, TopComponent.PERSISTENCE_ONLY_OPENED

Default:

0