org.netbeans.core.spi.multiview

Class MultiViewFactory

java.lang.Object

org.netbeans.core.spi.multiview.MultiViewFactory

public final class MultiViewFactory
extends Object

Factory class for creating top components handling multi views.

Field Summary

Fields

Modifier and Type	Field and Description
static MultiViewElement	BLANK_ELEMENT A utility singleton instance of MultiViewElement that does nothing.
static Action	NOOP_CLOSE_ACTION a utility noop action instance to be used when no special handling is required in createUnsafeCloseState() method.

Method Summary

Modifier and Type	Method and Description
static CloneableTopComponent	createCloneableMultiView(MultiViewDescription[] descriptions, MultiViewDescription defaultDesc) Creates and returns new instance of cloneable top component with multi views.
static CloneableTopComponent	createCloneableMultiView(MultiViewDescription[] descriptions, MultiViewDescription defaultDesc, CloseOperationHandler closeHandler) Creates and returns new instance of cloneable top component with multi views.
static TopComponent	createMultiView(MultiViewDescription[] descriptions, MultiViewDescription defaultDesc) Creates and returns new instance of top component with multi views.
static TopComponent	createMultiView(MultiViewDescription[] descriptions, MultiViewDescription defaultDesc, CloseOperationHandler closeHandler) Creates and returns new instance of top component with multi views.
static CloseOperationState	createUnsafeCloseState(String warningId, Action proceedAction, Action discardAction) Utility method for MultiViewElements to create a CloseOperationState instance that warns about possible data loss.

Methods inherited from class java.lang.Object

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

Field Detail

BLANK_ELEMENT

public static final MultiViewElement BLANK_ELEMENT

A utility singleton instance of MultiViewElement that does nothing.

NOOP_CLOSE_ACTION

public static final Action NOOP_CLOSE_ACTION

a utility noop action instance to be used when no special handling is required in createUnsafeCloseState() method.

Method Detail

createMultiView

public static TopComponent createMultiView(MultiViewDescription[] descriptions,
                                           MultiViewDescription defaultDesc)

Creates and returns new instance of top component with multi views. PLEASE NOTE: a non-cloneable TopComponent is not able to embed editors aka subclasses of CloneableEditor correctly. Use createCloneableMultiView() method in such a case.

Please see MultiViews.createMultiView(java.lang.String, T) for loosely coupled variant of this method which may be more suitable for modular environment.

Parameters:

descriptions - array of descriptions of tabs in the multiview.

defaultDesc - the initial selection, one of the descriptions array values.

createMultiView

public static TopComponent createMultiView(MultiViewDescription[] descriptions,
                                           MultiViewDescription defaultDesc,
                                           CloseOperationHandler closeHandler)

Creates and returns new instance of top component with multi views. PLEASE NOTE: a non-cloneable TopComponent is not able to embed editors aka subclasses of CloneableEditor correctly. Use createCloneableMultiView() method in such a case.

Please see MultiViews.createMultiView(java.lang.String, T) for loosely coupled variant of this method which may be more suitable for modular environment.

Parameters:

descriptions - array of descriptions of tabs in the multiview.

defaultDesc - the initial selection, one of the descriptions array values.

closeHandler - handles closing of the multiview component, useful when any of the embedded elements can be in modified state and closing would cause a dataloss..

createCloneableMultiView

public static CloneableTopComponent createCloneableMultiView(MultiViewDescription[] descriptions,
                                                             MultiViewDescription defaultDesc)

Creates and returns new instance of cloneable top component with multi views.

Please see MultiViews.createCloneableMultiView(java.lang.String, T) for loosely coupled variant of this method which may be more suitable for modular environment.

Parameters:

descriptions - array of descriptions of tabs in the multiview.

defaultDesc - the initial selection, one of the descriptions array values.

createCloneableMultiView

public static CloneableTopComponent createCloneableMultiView(MultiViewDescription[] descriptions,
                                                             MultiViewDescription defaultDesc,
                                                             CloseOperationHandler closeHandler)

Creates and returns new instance of cloneable top component with multi views.

Please see MultiViews.createCloneableMultiView(java.lang.String, T) for loosely coupled variant of this method which may be more suitable for modular environment.

Parameters:

descriptions - array of descriptions of tabs in the multiview.

defaultDesc - the initial selection, one of the descriptions array values.

closeHandler - handles closing of the multiview component, useful when any of the embedded elements can be in modified state and closing would cause a dataloss..

createUnsafeCloseState

public static CloseOperationState createUnsafeCloseState(String warningId,
                                                         Action proceedAction,
                                                         Action discardAction)

Utility method for MultiViewElements to create a CloseOperationState instance that warns about possible data loss. Corrective actions can be defined.

There is a default implementation of CloseOperationHandler. It uses warningId of all elements with unsafe close state to select the unique ones. These unique elements are then presented in a question box and user can decide to save or discard them. The user friendly message in such dialog is taken from proceedAction.getValue(Action.LONG_DESCRIPTION), if present.

Parameters:

warningId - an id that identifies the problem, the CloseOperationHandler used in the component should know about the warning's meaning and handle appropriately

proceedAction - will be performed when the CloseOperationHandler decides that closing the component is ok and changes are to be saved.

discardAction - will be performed when the CloseOperationHandler decides that the nonsaved data shall be discarded