| org.netbeans.core.spi.multiview.MultiViewDescription
All known Subclasses: org.netbeans.core.multiview.MVDesc,
| MultiViewDescription | | public interface MultiViewDescription (Code) | | Description of multi view element. Implementations should be lightweight
and fast. Creating heavyweight
org.netbeans.core.spi.multiview.MultiViewElement instances asociated with
Swing visual representation should be done lazily in
MultiViewDescription.createElement methods.
The implementing class should be serializable. For performance reasons,
don't include the element into serialization of the description. That one will be handled
separately when necessary.
author:
Dafe Simonek, Milos Kleint |
| Method Summary | |
| public MultiViewElement | createElement()
Creates and returns asociated multi view element. | | public String | getDisplayName()
Gets localized display name of multi view element. | | public HelpCtx | getHelpCtx()
Get the help context of multi view element. | | public Image | getIcon()
Icon for the MultiViewDescription's multiview component. | | public int | getPersistenceType()
Gets persistence type of multi view element, the TopComponent will decide
on it's onw persistenceType based on the sum of all it's elements. | | public String | preferredID()
A Description's contribution
to unique
org.openide.windows.TopComponent 's Id returned by getID. |
| createElement | | public MultiViewElement createElement()(Code) | | Creates and returns asociated multi view element. it is called just once during the lifecycle of the
multiview component.
the multiview element associated with this description |
| getDisplayName | | public String getDisplayName()(Code) | | Gets localized display name of multi view element. Will be placed on the Element's toggle button.
localized display name |
| getHelpCtx | | public HelpCtx getHelpCtx()(Code) | | Get the help context of multi view element.
|
| getIcon | | public Image getIcon()(Code) | | Icon for the MultiViewDescription's multiview component. Will be shown as TopComponent's icon
when this element is selected.
the icon of multi view element |
| getPersistenceType | | public int getPersistenceType()(Code) | | Gets persistence type of multi view element, the TopComponent will decide
on it's onw persistenceType based on the sum of all it's elements.
org.openide.windows.TopComponent.PERSISTENCE_ALWAYS has higher priority than
org.openide.windows.TopComponent.PERSISTENCE_ONLY_OPENED and
org.openide.windows.TopComponent.PERSISTENCE_NEVER has lowest priority.
The
org.openide.windows.TopComponent will be stored only if at least one element requesting persistence
was made visible.
|
| preferredID | | public String preferredID()(Code) | | A Description's contribution
to unique
org.openide.windows.TopComponent 's Id returned by getID. Returned value is used as starting
value for creating unique
org.openide.windows.TopComponent ID for whole enclosing multi view
component.
Value should be preferably unique, but need not be.
|
|
|