@MimeLocation(subfolderName="MultiView") public interface MultiViewDescription
MultiViewElement
instances asociated with
Swing visual representation should be done lazily in 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.Modifier and Type | Method and Description |
---|---|
MultiViewElement |
createElement()
Creates and returns asociated multi view element.
|
String |
getDisplayName()
Gets localized display name of multi view element.
|
HelpCtx |
getHelpCtx()
Get the help context of multi view element.
|
Image |
getIcon()
Icon for the MultiViewDescription's multiview component.
|
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.
|
String |
preferredID()
A Description's contribution
to unique
TopComponent 's Id returned by getID . |
int getPersistenceType()
TopComponent.PERSISTENCE_ALWAYS
has higher priority than TopComponent.PERSISTENCE_ONLY_OPENED
and TopComponent.PERSISTENCE_NEVER
has lowest priority.
The TopComponent
will be stored only if at least one element requesting persistence
was made visible.String getDisplayName()
@CheckForNull Image getIcon()
HelpCtx getHelpCtx()
String preferredID()
TopComponent
's Id returned by getID
. Returned value is used as starting
value for creating unique TopComponent
ID for whole enclosing multi view
component.
Value should be preferably unique, but need not be.MultiViewElement createElement()
Built on June 4 2024. | Copyright © 2017-2024 Apache Software Foundation. All Rights Reserved.