org.openide.windows

Class TopComponent.SubComponent

java.lang.Object

org.openide.windows.TopComponent.SubComponent

Enclosing class:

TopComponent

public static final class TopComponent.SubComponent
extends Object

Representation of a visual sub-component displayed in a TopComponent, for example sub-tabs in a multiview window.

Since:

6.52

See Also:

TopComponent.getSubComponents()

Constructor Summary

Constructors

Constructor and Description
SubComponent(String displayName, ActionListener activator, boolean active) C'tor
SubComponent(String displayName, String description, ActionListener activator, boolean active) C'tor
SubComponent(String displayName, String description, ActionListener activator, boolean active, Lookup lookup, boolean showing) C'tor

Method Summary

Modifier and Type	Method and Description
void	activate() Make this sub-component the active/selected one.
String	getDescription()
String	getDisplayName()
Lookup	getLookup()
boolean	isActive()
boolean	isShowing()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubComponent

public SubComponent(String displayName,
                    ActionListener activator,
                    boolean active)

C'tor

Parameters:

displayName - Subcomponent's display name.

activator - ActionListener to invoke when the sub-component needs to be actived.

active - True if the given sub-component is currently active, e.g. multiview sub-tab is selected.

SubComponent

public SubComponent(String displayName,
                    String description,
                    ActionListener activator,
                    boolean active)

C'tor

Parameters:

displayName - Subcomponent's display name.

description - Short description to show in a tooltip.

activator - ActionListener to invoke when the sub-component needs to be actived.

active - True if the given sub-component is currently active, e.g. multiview sub-tab is selected.

SubComponent

public SubComponent(String displayName,
                    String description,
                    ActionListener activator,
                    boolean active,
                    Lookup lookup,
                    boolean showing)

C'tor

Parameters:

displayName - Subcomponent's display name.

description - Short description to show in a tooltip.

activator - ActionListener to invoke when the sub-component needs to be actived.

active - True if the given sub-component is currently active, e.g. multiview sub-tab is selected.

lookup - the lookup of the given sub-component

showing - True if the given sub-component is currently showing, e.g. multiview sub-tab is selected or part of a split.

Method Detail

getLookup

public Lookup getLookup()

Returns:

the lookup of the given sub-component, could be null

isShowing

public boolean isShowing()

Returns:

True if this sub-component is the active/selected one or part of a split.

isActive

public final boolean isActive()

Returns:

True if this sub-component is the active/selected one.

getDescription

public final String getDescription()

getDisplayName

public final String getDisplayName()

activate

public final void activate()

Make this sub-component the active/selected one.