com.nomagic.magicdraw.ui.dialogs.selection

Class ElementSelectionDlgFactory

java.lang.Object

com.nomagic.magicdraw.ui.dialogs.selection.ElementSelectionDlgFactory

@OpenApi
public class ElementSelectionDlgFactory
extends java.lang.Object

Element Selection dialog factory class. This factory should be used to create instances of ElementSelectionDlg and also configure dialog initial settings.

Selecting elements via element Selection dialog

 // Use ElementSelectionDlgFactory.create(...) methods to create element selection dialog.
 Frame dialogParent = MDDialogParentProvider.getProvider().getDialogParent();
 ElementSelectionDlg dlg = ElementSelectionDlgFactory.create(dialogParent);

 // Use ElementSelectionDlgFactory.initSingle(...) methods to initialize the dialog with single element selection mode.
 ElementSelectionDlgFactory.initSingle(....);

 // Use ElementSelectionDlgFactory.initMultiple(...) methods to initialize the dialog with multiple element selection mode.
 ElementSelectionDlgFactory.initMultiple(....);

 // Display dialog for the user to select elements.
 dlg.show();

 // Check if the user has clicked "Ok".
 if (dlg.isOkClicked())
 {
     // Get selected element in single selection mode.a
     BaseElement selected = dlg.getSelectedElement();

     // Get selected elements in multiple selection mode.
     BaseElement selected = dlg.getSelectedElements();
 }
 

See Also:

ElementSelectionDlg, SelectElementInfo, ClassTypes, SelectElementTypes, TypeFilter, TypeFilterImpl, ModelHelper

Method Summary

Modifier and Type	Method and Description
static java.util.Collection	collectDisplayable(java.util.Collection displayable, java.util.Collection selectable) Collect displayable types for a given selectable types if given displayable is null
static ElementSelectionDlg	create() Create an instance of the dialog
static ElementSelectionDlg	create(java.awt.Dialog parent) Create an instance of dialog
static ElementSelectionDlg	create(java.awt.Dialog parent, java.lang.String title, java.lang.String helpPath) Create an instance of dialog
static ElementSelectionDlg	create(java.awt.Frame parent) Create an instance of dialog
static ElementSelectionDlg	create(java.awt.Frame parent, java.lang.String title, java.lang.String helpPath) Create an instance of dialog
static ElementSelectionDlg	create(java.awt.Window parent) Create an instance of dialog
static ElementSelectionDlg	create(java.awt.Window parent, java.lang.String title, java.lang.String helpPath) Create an instance of dialog
static TypeFilter	createDisplayableForSelectable(java.util.Collection selectable) Create displayable types filter for a given selectable types.
static TypeFilter	createDisplayableForSelectable(java.util.Collection displayable, TypeFilter selectable) Create displayable types filter for a given selectable types filter if given displayable is null
static TypeFilter	createDisplayableForSelectable(TypeFilter selectable) Create displayable types filter for a given selectable types filter.
static void	initMultiple(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, boolean usedAsType, java.util.Collection<?> creatableTypes, java.util.List<?> selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initMultiple(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, boolean usedAsType, java.util.Collection<?> creatableTypes, java.lang.Object[] selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initMultiple(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, java.util.Collection<?> creatableTypes, java.util.List<?> selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initMultiple(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, java.util.Collection<?> creatableTypes, java.lang.Object[] selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initMultiple(ElementSelectionDlg dlg, SelectElementTypes types, SelectElementInfo info, java.util.List selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initMultiple(ElementSelectionDlg dlg, SelectElementTypes types, SelectElementInfo info, java.lang.Object[] selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initMultipleAsMultipleInitial(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, java.util.Collection<?> creatableTypes, java.util.List<?> selection) Initializes given dialog with a "multiple elements" selection mode.
static void	initSingle(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, boolean usedAsType, java.util.Collection<?> creatableTypes, java.lang.Object selection) Initializes given dialog with a "single element" selection mode.
static void	initSingle(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, java.util.Collection<?> creatableTypes, java.lang.Object selection) Initializes given dialog with a "single element" selection mode.
static void	initSingle(ElementSelectionDlg dlg, SelectElementTypes types, SelectElementInfo info, java.lang.Object selection) Initializes given dialog with a "single element" selection mode.

Methods inherited from class java.lang.Object

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

Method Detail

create

@OpenApi
public static ElementSelectionDlg create()

Create an instance of the dialog

Returns:

dialog instance

create

@OpenApi
public static ElementSelectionDlg create(@CheckForNull
                                                  java.awt.Frame parent)

Create an instance of dialog

Parameters:

parent - dialog parent

Returns:

dialog instance

create

@OpenApi
public static ElementSelectionDlg create(@CheckForNull
                                                  java.awt.Frame parent,
                                                  @CheckForNull
                                                  java.lang.String title,
                                                  @CheckForNull
                                                  java.lang.String helpPath)

Create an instance of dialog

Parameters:

parent - dialog parent

title - dialog title

helpPath - help id

Returns:

dialog instance

create

@OpenApi
public static ElementSelectionDlg create(@CheckForNull
                                                  java.awt.Window parent)

Create an instance of dialog

Parameters:

parent - dialog parent

Returns:

dialog instance

create

@OpenApi
public static ElementSelectionDlg create(@CheckForNull
                                                  java.awt.Window parent,
                                                  @CheckForNull
                                                  java.lang.String title,
                                                  @CheckForNull
                                                  java.lang.String helpPath)

Create an instance of dialog

Parameters:

parent - dialog parent

title - dialog title

helpPath - help id

Returns:

dialog instance

create

@OpenApi
public static ElementSelectionDlg create(@CheckForNull
                                                  java.awt.Dialog parent)

Create an instance of dialog

Parameters:

parent - dialog parent

Returns:

dialog instance

create

@OpenApi
public static ElementSelectionDlg create(@CheckForNull
                                                  java.awt.Dialog parent,
                                                  @CheckForNull
                                                  java.lang.String title,
                                                  @CheckForNull
                                                  java.lang.String helpPath)

Create an instance of dialog

Parameters:

parent - dialog parent

title - dialog title

helpPath - help id

Returns:

dialog instance

collectDisplayable

@OpenApi
public static java.util.Collection collectDisplayable(@CheckForNull
                                                               java.util.Collection displayable,
                                                               java.util.Collection selectable)

Collect displayable types for a given selectable types if given displayable is null

Parameters:

displayable - displayable types

selectable - selectable types

Returns:

displayable types

createDisplayableForSelectable

@OpenApi
public static TypeFilter createDisplayableForSelectable(@CheckForNull
                                                                 java.util.Collection displayable,
                                                                 TypeFilter selectable)

Create displayable types filter for a given selectable types filter if given displayable is null

Parameters:

displayable - displayable types

selectable - selectable types

Returns:

displayable types

createDisplayableForSelectable

@OpenApi
public static TypeFilter createDisplayableForSelectable(TypeFilter selectable)

Create displayable types filter for a given selectable types filter.

Parameters:

selectable - selectable types

Returns:

displayable types

createDisplayableForSelectable

@OpenApi
public static TypeFilter createDisplayableForSelectable(java.util.Collection selectable)

Create displayable types filter for a given selectable types.

Parameters:

selectable - selectable types

Returns:

displayable types

initSingle

@OpenApi
public static void initSingle(ElementSelectionDlg dlg,
                                       SelectElementTypes types,
                                       SelectElementInfo info,
                                       @CheckForNull
                                       java.lang.Object selection)

Initializes given dialog with a "single element" selection mode. It means dialog will allow to select just a single element.

Parameters:

dlg - dialog

types - element selection information

info - dialog settings

selection - initially selected element

initMultiple

@OpenApi
public static void initMultiple(ElementSelectionDlg dlg,
                                         SelectElementTypes types,
                                         SelectElementInfo info,
                                         @CheckForNull
                                         java.lang.Object[] selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements.

Parameters:

dlg - dialog

types - element selection information

info - dialog settings

selection - initially selected elements

initMultiple

@OpenApi
public static void initMultiple(ElementSelectionDlg dlg,
                                         SelectElementTypes types,
                                         SelectElementInfo info,
                                         @CheckForNull
                                         java.util.List selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements.

Parameters:

dlg - dialog

types - element selection information

info - dialog settings

selection - initially selected elements

initSingle

@OpenApi
public static void initSingle(ElementSelectionDlg dlg,
                                       SelectElementInfo info,
                                       TypeFilter visibleElementsFilter,
                                       TypeFilter selectableElementsFilter,
                                       @CheckForNull
                                       java.util.Collection<?> creatableTypes,
                                       @CheckForNull
                                       java.lang.Object selection)

Initializes given dialog with a "single element" selection mode. It means dialog will allow to select just a single element.

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element

initSingle

@OpenApi
public static void initSingle(ElementSelectionDlg dlg,
                                       SelectElementInfo info,
                                       TypeFilter visibleElementsFilter,
                                       TypeFilter selectableElementsFilter,
                                       boolean usedAsType,
                                       @CheckForNull
                                       java.util.Collection<?> creatableTypes,
                                       @CheckForNull
                                       java.lang.Object selection)

Initializes given dialog with a "single element" selection mode. It means dialog will allow to select just a single element.

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

usedAsType - is this dialog instance is used to select some UML Type. If true, some special filters from DSL will be used for elements filtering

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element

initMultiple

@OpenApi
public static void initMultiple(ElementSelectionDlg dlg,
                                         SelectElementInfo info,
                                         TypeFilter visibleElementsFilter,
                                         TypeFilter selectableElementsFilter,
                                         boolean usedAsType,
                                         @CheckForNull
                                         java.util.Collection<?> creatableTypes,
                                         @CheckForNull
                                         java.lang.Object[] selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements.

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

usedAsType - is this dialog instance is used to select some UML Type. If true, some special filters from DSL will be used for elements filtering

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element

initMultiple

@OpenApi
public static void initMultiple(ElementSelectionDlg dlg,
                                         SelectElementInfo info,
                                         TypeFilter visibleElementsFilter,
                                         TypeFilter selectableElementsFilter,
                                         @CheckForNull
                                         java.util.Collection<?> creatableTypes,
                                         @CheckForNull
                                         java.lang.Object[] selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements.

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element

initMultiple

@OpenApi
public static void initMultiple(ElementSelectionDlg dlg,
                                         SelectElementInfo info,
                                         TypeFilter visibleElementsFilter,
                                         TypeFilter selectableElementsFilter,
                                         @CheckForNull
                                         java.util.Collection<?> creatableTypes,
                                         @CheckForNull
                                         java.util.List<?> selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements.

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element

initMultiple

@OpenApi
public static void initMultiple(ElementSelectionDlg dlg,
                                         SelectElementInfo info,
                                         TypeFilter visibleElementsFilter,
                                         TypeFilter selectableElementsFilter,
                                         boolean usedAsType,
                                         @CheckForNull
                                         java.util.Collection<?> creatableTypes,
                                         @CheckForNull
                                         java.util.List<?> selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements.

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

usedAsType - is this dialog instance is used to select some UML Type. If true, some special filters from DSL will be used for elements filtering

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element

initMultipleAsMultipleInitial

@OpenApi
public static void initMultipleAsMultipleInitial(ElementSelectionDlg dlg,
                                                          SelectElementInfo info,
                                                          TypeFilter visibleElementsFilter,
                                                          TypeFilter selectableElementsFilter,
                                                          @CheckForNull
                                                          java.util.Collection<?> creatableTypes,
                                                          @CheckForNull
                                                          java.util.List<?> selection)

Initializes given dialog with a "multiple elements" selection mode. It means dialog will allow to select several elements. Allows to set Multiple as mode initial multiple, (All initMultiple only use SINGLE_INITIAL)

Parameters:

dlg - dialog

info - dialog settings

visibleElementsFilter - filter providing visible elements in the dialog

selectableElementsFilter - filter providing selectable elements in the dialog

creatableTypes - collection of creatable types (choice on Create button)

selection - initially selected element