MultiViewElementCallback (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.spi.multiview
Class MultiViewElementCallback

java.lang.Object
  org.netbeans.core.spi.multiview.MultiViewElementCallback

public final class MultiViewElementCallback
extends Object
extends Object

Requester type of class, allowing implementors of MultiViewElement to send requests back to enclosing component and window system. Enclosing component or other part of window system will set the instance of this class to elements upon instantiation or deserialization of the element to receive requests properly. Implementors of MultiViewElement shall not attempt to serialize the passed callback instance.

Method Summary

Action[] createDefaultActions()
          Creates the default TopComponent actions as defined by the Window System.

TopComponent getTopComponent()
          Returns the enclosing Multiview's topcomponent.

boolean isSelectedElement()
          Element can check if it's currently the selected element.

void requestActive()
          Activates this multi view element in enclosing multi view component context, if enclosing multi view top component is opened.

void requestVisible()
          Selects this multi view element in enclosing component context, if component is opened, but does not activate it unless enclosing component is in active mode already.

void updateTitle(String title)
          Update the multiview's topcomponent title.

Methods inherited from class java.lang.Object

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

Method Summary
`Action[]`	`createDefaultActions()` Creates the default TopComponent actions as defined by the Window System.
`TopComponent`	`getTopComponent()` Returns the enclosing Multiview's topcomponent.
`boolean`	`isSelectedElement()` Element can check if it's currently the selected element.
`void`	`requestActive()` Activates this multi view element in enclosing multi view component context, if enclosing multi view top component is opened.
`void`	`requestVisible()` Selects this multi view element in enclosing component context, if component is opened, but does not activate it unless enclosing component is in active mode already.
`void`	`updateTitle(String title)` Update the multiview's topcomponent title.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

requestActive

public void requestActive()

Activates this multi view element in enclosing multi view component context, if enclosing multi view top component is opened.

requestVisible

public void requestVisible()

Selects this multi view element in enclosing component context, if component is opened, but does not activate it unless enclosing component is in active mode already.

createDefaultActions

public Action[] createDefaultActions()

Creates the default TopComponent actions as defined by the Window System. Should be used by the element when constructing it's own getActions() return value.

updateTitle

public void updateTitle(String title)

Update the multiview's topcomponent title.

isSelectedElement

public boolean isSelectedElement()

Element can check if it's currently the selected element.

getTopComponent

public TopComponent getTopComponent()

Returns the enclosing Multiview's topcomponent.