com.nomagic.magicdraw.ui.dialogs

Class SelectElementTypes

java.lang.Object

com.nomagic.magicdraw.ui.dialogs.SelectElementTypes

@OpenApiAll
public class SelectElementTypes
extends java.lang.Object

Element types for element(s) selection dialog.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Collection	create The types (metaclasses) of elements or stereotypes that can be created in the select element dialog.
java.util.Collection	display The types (metaclasses) of elements that should be displayed in the select element dialog.
java.util.Collection	restricted The types (metaclasses) of elements or stereotypes that restricts the element selection.
java.util.Collection	select The types (metaclasses) of elements that can be selected in the select element dialog.
boolean	usedAsTypes The result will be used as "type", so possible elements should be filtered by DSL engine doNotSuggestAsType flag.

Constructor Summary

Constructors

Constructor and Description
SelectElementTypes(java.util.Collection display, java.util.Collection select)
SelectElementTypes(java.util.Collection display, java.util.Collection select, java.util.Collection create) Constructor.
SelectElementTypes(java.util.Collection display, java.util.Collection select, java.util.Collection create, boolean appendOwnersToCreatable) Constructor.
SelectElementTypes(java.util.Collection display, java.util.Collection select, java.util.Collection create, java.util.Collection restricted) Constructor.
SelectElementTypes(java.util.Collection display, java.util.Collection select, java.util.Collection create, java.util.Collection restricted, boolean appendOwnersToCreatable) Constructor.
SelectElementTypes(java.util.Collection display, java.util.Collection select, Stereotype stereotype)
SelectElementTypes(ElementListProperty property, boolean creatable)
SelectElementTypes(ElementListProperty property, boolean creatable, boolean appendOwnersToCreatable)
SelectElementTypes(ElementProperty property, boolean creatable)
SelectElementTypes(ElementProperty property, boolean creatable, boolean appendOwnersToCreatable)
SelectElementTypes(Project project, com.nomagic.magicdraw.ui.dsl.DSLHelper.DSLReferenceInfo info, boolean creatable) Constructs selectable types from DSL information.
SelectElementTypes(Project project, com.nomagic.magicdraw.ui.dsl.DSLHelper.DSLReferenceInfo info, boolean creatable, boolean appendOwnersToCreatable) Constructs selectable types from DSL information.

Method Summary

Modifier and Type	Method and Description
static SelectElementTypes	create(Property property, boolean creatable) An utility method to create an instance for given property.
static SelectElementTypes	create(Property property, boolean creatable, boolean appendOwnersToCreatable) An utility method to create an instance for given property.
java.util.Collection	getRestricted()
java.util.Collection	getSelect()
protected void	init(java.util.Collection select, java.util.Collection display, java.util.Collection restricted, boolean creatable, boolean appendCreatableOwners)

Methods inherited from class java.lang.Object

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

Field Detail

display

@OpenApi
public java.util.Collection display

The types (metaclasses) of elements that should be displayed in the select element dialog.

select

@OpenApi
public java.util.Collection select

The types (metaclasses) of elements that can be selected in the select element dialog.

create

@OpenApi
public java.util.Collection create

The types (metaclasses) of elements or stereotypes that can be created in the select element dialog. Stereotype means that element with the applied stereotype will be created.

restricted

@OpenApi
public java.util.Collection restricted

The types (metaclasses) of elements or stereotypes that restricts the element selection. If the restricted element is stereotype - only element that has applied this stereotype can be selected.

usedAsTypes

public boolean usedAsTypes

The result will be used as "type", so possible elements should be filtered by DSL engine doNotSuggestAsType flag.

Constructor Detail

SelectElementTypes

public SelectElementTypes(ElementProperty property,
                          boolean creatable)

SelectElementTypes

public SelectElementTypes(ElementProperty property,
                          boolean creatable,
                          boolean appendOwnersToCreatable)

SelectElementTypes

public SelectElementTypes(ElementListProperty property,
                          boolean creatable)

SelectElementTypes

public SelectElementTypes(ElementListProperty property,
                          boolean creatable,
                          boolean appendOwnersToCreatable)

SelectElementTypes

public SelectElementTypes(Project project,
                          com.nomagic.magicdraw.ui.dsl.DSLHelper.DSLReferenceInfo info,
                          boolean creatable)

Constructs selectable types from DSL information.

Parameters:

project - project

info - dsl reference info

creatable - true if elements must be allowed to create

SelectElementTypes

public SelectElementTypes(Project project,
                          com.nomagic.magicdraw.ui.dsl.DSLHelper.DSLReferenceInfo info,
                          boolean creatable,
                          boolean appendOwnersToCreatable)

Constructs selectable types from DSL information.

Parameters:

project - project

info - dsl reference info

creatable - true if elements must be allowed to create

appendOwnersToCreatable - true if possible owners should be added into creatable metaclasses

SelectElementTypes

public SelectElementTypes(@CheckForNull
                          java.util.Collection display,
                          java.util.Collection select)

SelectElementTypes

public SelectElementTypes(java.util.Collection display,
                          java.util.Collection select,
                          @CheckForNull
                          Stereotype stereotype)

SelectElementTypes

@OpenApi
public SelectElementTypes(@CheckForNull
                                   java.util.Collection display,
                                   java.util.Collection select,
                                   @CheckForNull
                                   java.util.Collection create)

Constructor.

Parameters:

display - display value.

select - select value.

create - create value.

SelectElementTypes

@OpenApi
public SelectElementTypes(@CheckForNull
                                   java.util.Collection display,
                                   java.util.Collection select,
                                   @CheckForNull
                                   java.util.Collection create,
                                   boolean appendOwnersToCreatable)

Constructor.

Parameters:

display - display value.

select - select value.

create - create value.

appendOwnersToCreatable - true if possible owners should be added into creatable metaclasses

SelectElementTypes

@OpenApi
public SelectElementTypes(@CheckForNull
                                   java.util.Collection display,
                                   java.util.Collection select,
                                   @CheckForNull
                                   java.util.Collection create,
                                   java.util.Collection restricted)

Constructor.

Parameters:

display - display value.

select - select value.

create - create value.

restricted - restricted value.

SelectElementTypes

@OpenApi
public SelectElementTypes(@CheckForNull
                                   java.util.Collection display,
                                   java.util.Collection select,
                                   @CheckForNull
                                   java.util.Collection create,
                                   java.util.Collection restricted,
                                   boolean appendOwnersToCreatable)

Constructor.

Parameters:

display - display value.

select - select value.

create - create value.

restricted - restricted value.

appendOwnersToCreatable - true if possible owners should be added into creatable metaclasses

Method Detail

init

protected void init(java.util.Collection select,
                    java.util.Collection display,
                    java.util.Collection restricted,
                    boolean creatable,
                    boolean appendCreatableOwners)

getSelect

public java.util.Collection getSelect()

getRestricted

public java.util.Collection getRestricted()

create

@CheckForNull
public static SelectElementTypes create(Property property,
                                                      boolean creatable)

An utility method to create an instance for given property.

Parameters:

property - the given property

creatable - true if elements must be allowed to create

Returns:

a new instance in case property is ElementProperty or Element ListProperty or null

See Also:

SelectElementTypes(com.nomagic.magicdraw.properties.ElementProperty, boolean), SelectElementTypes(com.nomagic.magicdraw.properties.ElementListProperty, boolean)

create

@CheckForNull
public static SelectElementTypes create(Property property,
                                                      boolean creatable,
                                                      boolean appendOwnersToCreatable)

An utility method to create an instance for given property.

Parameters:

property - the given property

creatable - true if elements must be allowed to create

appendOwnersToCreatable - true if possible owners should be added into creatable metaclasses

Returns:

a new instance in case property is ElementProperty or Element ListProperty or null

See Also:

SelectElementTypes(com.nomagic.magicdraw.properties.ElementProperty, boolean), SelectElementTypes(com.nomagic.magicdraw.properties.ElementListProperty, boolean)