TopComponent.Description (Window System API)

Skip navigation links

org.openide.windows 6.74.1

All Classes

SEARCH:

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Retention(RUNTIME)
@Target(TYPE)
public static @interface TopComponent.Description
```
Provides basic information about the persistence of a TopComponent. Using this annotation is preferred to overriding 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 Description

java.lang.String preferredID
The default value for TopComponent.preferredID().

Optional Element Summary

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

- Element Detail
  - preferredID
```
java.lang.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
```
java.lang.String iconBase
```
    The icon to load for TopComponent.getIcon().
    
    Default:
    
    ""
- - persistenceType
```
int persistenceType
```
    Default value for TopComponent.getPersistenceType().
    
    Returns:
    
    one of TopComponent.PERSISTENCE_ALWAYS, TopComponent.PERSISTENCE_NEVER, TopComponent.PERSISTENCE_ONLY_OPENED
    
    Default:
    
    0

Skip navigation links

org.openide.windows 6.74.1

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

Built on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.