MultiViewHandler (MultiView Windows) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.core.multiview/1 1.9

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.core.api.multiview
Class MultiViewHandler

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

public final class MultiViewHandler
extends Object
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

MultiViewPerspective[] getPerspectives()
          Returns the array of MultiViewPerspectives that the TopComponent is composed of.

MultiViewPerspective getSelectedPerspective()
          Returns the currently selected MultiViewPerspective in the TopComponent.

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 Summary
`MultiViewPerspective[]`	`getPerspectives()` Returns the array of `MultiViewPerspective`s that the `TopComponent` is composed of.
`MultiViewPerspective`	`getSelectedPerspective()` Returns the currently selected `MultiViewPerspective` in the `TopComponent`.
`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