org.netbeans.core.api.multiview

Class MultiViewHandler

java.lang.Object

org.netbeans.core.api.multiview.MultiViewHandler

public final class MultiViewHandler
extends Object

A handler for the multiview's TopComponent, obtainable via MultiViewFactory, that allows examination of Component's content and programatic changes in visible/activated elements.

Method Summary

Modifier and Type	Method and Description
void	addMultiViewDescription(MultiViewDescription descr, int position) Adds another multiview element to an existing multiview TopComponent.
MultiViewPerspective[]	getPerspectives() Returns the array of MultiViewPerspectives that the TopComponent is composed of.
MultiViewPerspective	getSelectedPerspective() Returns the currently selected MultiViewPerspective in the TopComponent.
void	removeMultiViewDescription(MultiViewDescription descr) Removes multiview element that was added at runtime.
void	requestActive(MultiViewPerspective desc) Requests focus for the MultiViewPerspective passed as parameter, if necessary will switch from previously selected MultiViewPerspective
void	requestVisible(MultiViewPerspective desc) Changes the visible MultiViewPerspective to the one passed as parameter.

Methods inherited from class java.lang.Object

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

Method Detail

getPerspectives

public MultiViewPerspective[] getPerspectives()

Returns the array of MultiViewPerspectives that the TopComponent is composed of.

Returns:

array of defined perspectives.

getSelectedPerspective

public MultiViewPerspective getSelectedPerspective()

Returns the currently selected MultiViewPerspective in the TopComponent. It's element can be either visible or activated.

Returns:

selected perspective

requestActive

public void requestActive(MultiViewPerspective desc)

Requests focus for the MultiViewPerspective passed as parameter, if necessary will switch from previously selected MultiViewPerspective

Parameters:

desc - the new active selection

requestVisible

public void requestVisible(MultiViewPerspective desc)

Changes the visible MultiViewPerspective to the one passed as parameter.

Parameters:

desc - the new selection

addMultiViewDescription

public void addMultiViewDescription(MultiViewDescription descr,
                                    int position)

Adds another multiview element to an existing multiview TopComponent. Such elements are not persisted.

Parameters:

descr - The description of the element to be added.

position - Position of the new element or -1 to append the element to the end.

Since:

1.38

removeMultiViewDescription

public void removeMultiViewDescription(MultiViewDescription descr)

Removes multiview element that was added at runtime.

Parameters:

descr - The description of the element that was previously passed to addMultiViewDescription method.

Since:

1.38

See Also:

MultiViewHandler.addMultiViewDescription(org.netbeans.core.spi.multiview.MultiViewDescription, int)