org.netbeans.core.api.multiview
Class MultiViewPerspective

java.lang.Object
  org.netbeans.core.api.multiview.MultiViewPerspective

public final class MultiViewPerspective
extends Object

Description of multi view element.

Method Summary

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 multi view 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPersistenceType

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. 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.

getDisplayName

public String getDisplayName()

Gets localized display name of multi view element. Will be placed on the Element's toggle button.

Returns:

the display name for this view element.

getIcon

@CheckForNull
public Image getIcon()

Icon for the multi view component. Will be shown as TopComponent's icon when this element is selected.

Returns:

The icon of multi view element, or null

getHelpCtx

public HelpCtx getHelpCtx()

Get the help context of multi view element.

preferredID

public String preferredID()

A Description's contribution to unique TopComponent's Id returned by getID. Returned value is used as starting value for creating unique TopComponent ID for whole enclosing multi view component.