Package com.nomagic.magicdraw.properties

Class ElementListProperty

java.lang.Object

com.nomagic.magicdraw.properties.Property

com.nomagic.magicdraw.properties.ListProperty

com.nomagic.magicdraw.properties.ElementListProperty

All Implemented Interfaces:

com.nomagic.magicdraw.properties.ElementFilterProperty, PropertyVisitorAcceptor, java.lang.Cloneable

Direct Known Subclasses:

ProjectOptions.ValidationRulesProperty, ProjectOptions.ValidationSuiteProperty

@OpenApiAll
public class ElementListProperty
extends ListProperty
implements com.nomagic.magicdraw.properties.ElementFilterProperty

Property for selecting a list of Elements of given type. Editor of this property allows to choose some specific Elements from all existing elements in the current project

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	containment	Flag indicates if the elements are contained.
private java.util.Collection	displayableTypes	The collection of displayable elements class types.
private boolean	ordered	Flag indicates if the elements are ordered.
private Project	project
private java.util.Collection	selectableRestrictedElements	Stereotypes and metaclasses for filtering selectable elements
private java.util.Collection	selectableTypes	The collection of selectable elements class types.

Fields inherited from class com.nomagic.magicdraw.properties.Property

DEFAULT_PROPERTY_RESOURCE_PROVIDER, EDITABLE, NULL, NULL_ID_PROPERTY_RESOURCE_PROVIDER, UNDEFINED, VALUE

Constructor Summary

Constructors

Constructor	Description
ElementListProperty()	Creates and initializes a new ModelElementListProperty object.
ElementListProperty(java.lang.String id, java.lang.Object value)	Creates and initializes a new ModelElementListProperty object from specified parameters.

Method Summary

Modifier and Type	Method	Description
void	accept(PropertyVisitor v)	Accepts the given visitor.
ElementListProperty	clone()	Clones the property.
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)	Delegates firePropertyChange to the PropertyChangeSupport, the member of this class, which reports a bound property update to any registered listeners.
java.lang.String	getClassType()	Returns a class type of the property.
java.util.Collection	getDisplayableTypes()	Returns displayable elements class types.
Element[]	getElements()
java.lang.String[]	getElementsIDs()	ID's of stored Elements.
java.lang.Object[]	getOriginalValue()
java.util.Collection	getSelectableRestrictedElements()
java.util.Collection	getSelectableTypes()	Returns selectable elements class types.
Stereotype	getStereotype()	Deprecated. This is a deprecated methods and you must use collection of restricted elements, not single stereotype
Element[]	getValue()	Returns an array of model elements.
java.lang.String	getValueStringRepresentation()	Returns value's string representation.
boolean	isContainment()	Check Element list property is Containment.
boolean	isOrdered()	Check Element list property is Ordered.
void	setContainment(boolean containment)
void	setDisplayableTypes(java.util.Collection displayableTypes)
void	setOrdered(boolean ordered)
void	setProject(Project project)
void	setPropertyData(java.util.Collection displayableTypes, java.util.Collection selectableTypes, boolean ordered, boolean containment)	Sets data for property members.
void	setSelectableRestrictedElements(java.util.Collection stereotypes)	Sets a stereotypes and metaclasses for filtering selectable elements
void	setSelectableTypes(java.util.Collection selectableTypes)
void	setValue(java.lang.Object value)	Sets a value of the property.

Methods inherited from class com.nomagic.magicdraw.properties.Property

_getValue, _isFrozen, _setFrozen, _setValue, addPropertyChangeListener, addSource, addSources, areValuesEqual, checkFrozen, checkFrozen, createCellEditor, createTableCellRenderer, equals, generateDefaultDescriptionID, getAdditionalProperties, getAdditionalProperty, getDescription, getDescriptionID, getFirstElementFromSources, getGroup, getID, getIntroductoryVersion, getName, getNonEditableReason, getProjectFromSourcesOrActive, getPureDescription, getResourceProvider, getResourceProviderID, getSourceAsElement, getSources, getSourcesAsStream, getUndefinedString, getUndefinedString, hashCode, isEditable, isUndefinedState, isValueCompatible, removePropertyChangeListener, setAdditionalProperties, setAdditionalProperty, setDescription, setDescriptionID, setEditable, setGroup, setID, setIntroductoryVersion, setNonEditableReason, setResourceProvider, setResourceProviderID, setSources, setUndefinedState, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

selectableTypes

@CheckForNull
private java.util.Collection selectableTypes

The collection of selectable elements class types.

displayableTypes

@CheckForNull
private java.util.Collection displayableTypes

The collection of displayable elements class types.

selectableRestrictedElements

private java.util.Collection selectableRestrictedElements

Stereotypes and metaclasses for filtering selectable elements

containment

private boolean containment

Flag indicates if the elements are contained.

ordered

private boolean ordered

Flag indicates if the elements are ordered.

project

@CheckForNull
private Project project

Constructor Detail

ElementListProperty

public ElementListProperty()

Creates and initializes a new ModelElementListProperty object.

ElementListProperty

public ElementListProperty(java.lang.String id,
                           @CheckForNull
                           java.lang.Object value)

Creates and initializes a new ModelElementListProperty object from specified parameters.

Parameters:

id - - id of the property.

value - - a value of the property.

Method Detail

getClassType

public java.lang.String getClassType()

Returns a class type of the property.

Specified by:

getClassType in interface PropertyVisitorAcceptor

Overrides:

getClassType in class ListProperty

Returns:

PropertyID.ELEMENT_LIST_PROPERTY

See Also:

PropertyID.ELEMENT_LIST_PROPERTY

setPropertyData

public void setPropertyData(@CheckForNull
                            java.util.Collection displayableTypes,
                            @CheckForNull
                            java.util.Collection selectableTypes,
                            boolean ordered,
                            boolean containment)

Sets data for property members. This method takes collections of class types. You must add into these collections class types from constants class ClassTypes.

Specified by:

setPropertyData in interface com.nomagic.magicdraw.properties.ElementFilterProperty

getSelectableTypes

@CheckForNull
public java.util.Collection getSelectableTypes()

Returns selectable elements class types.

Specified by:

getSelectableTypes in interface com.nomagic.magicdraw.properties.ElementFilterProperty

Returns:

selectable types.

getDisplayableTypes

@CheckForNull
public java.util.Collection getDisplayableTypes()

Returns displayable elements class types.

Specified by:

getDisplayableTypes in interface com.nomagic.magicdraw.properties.ElementFilterProperty

Returns:

displayable types.

isContainment

public boolean isContainment()

Check Element list property is Containment.

Specified by:

isContainment in interface com.nomagic.magicdraw.properties.ElementFilterProperty

Returns:

boolean.

isOrdered

public boolean isOrdered()

Check Element list property is Ordered.

Specified by:

isOrdered in interface com.nomagic.magicdraw.properties.ElementFilterProperty

Returns:

boolean.

setValue

public void setValue(@CheckForNull
                     java.lang.Object value)

Description copied from class: ListProperty

Sets a value of the property.

Overrides:

setValue in class ListProperty

Parameters:

value - a value.

getElements

public Element[] getElements()

getOriginalValue

public java.lang.Object[] getOriginalValue()

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)

Description copied from class: Property

Delegates firePropertyChange to the PropertyChangeSupport, the member of this class, which reports a bound property update to any registered listeners. No event is fired if old and new are equal and non-null.

Overrides:

firePropertyChange in class Property

Parameters:

propertyName - the programmatic name of the property that was changed.

oldValue - the old value of the property

newValue - the new value of the property

See Also:

PropertyChangeSupport

getElementsIDs

@CheckForNull
public java.lang.String[] getElementsIDs()

ID's of stored Elements. Real value of project.

Returns:

id's of elements

getValue

public Element[] getValue()

Returns an array of model elements.

Overrides:

getValue in class ListProperty

Returns:

an array of ModelElement.

clone

public ElementListProperty clone()

Clones the property.

Overrides:

clone in class ListProperty

Returns:

the clone of this property.

accept

public void accept(PropertyVisitor v)
            throws java.lang.Exception

Accepts the given visitor.

Specified by:

accept in interface PropertyVisitorAcceptor

Overrides:

accept in class ListProperty

Parameters:

v - the PropertyVisitor.

Throws:

java.lang.Exception

getValueStringRepresentation

public java.lang.String getValueStringRepresentation()

Description copied from class: Property

Returns value's string representation.

Overrides:

getValueStringRepresentation in class ListProperty

Returns:

string "null" if property does not have value; value. toString() if property has value.

setProject

public void setProject(@CheckForNull
                       Project project)

Specified by:

setProject in interface com.nomagic.magicdraw.properties.ElementFilterProperty

getSelectableRestrictedElements

public java.util.Collection getSelectableRestrictedElements()

Specified by:

getSelectableRestrictedElements in interface com.nomagic.magicdraw.properties.ElementFilterProperty

Returns:

stereotypes and metaclasses for filtering selectable elements

setSelectableRestrictedElements

public void setSelectableRestrictedElements(java.util.Collection stereotypes)

Sets a stereotypes and metaclasses for filtering selectable elements

Specified by:

setSelectableRestrictedElements in interface com.nomagic.magicdraw.properties.ElementFilterProperty

Parameters:

stereotypes - stereotypes

getStereotype

@CheckForNull
@Deprecated
public Stereotype getStereotype()

Deprecated.

This is a deprecated methods and you must use collection of restricted elements, not single stereotype

Returns a first stereotype from selectable restricted elements.

Returns:

first stereotype

See Also:

getSelectableRestrictedElements()

setSelectableTypes

public void setSelectableTypes(@CheckForNull
                               java.util.Collection selectableTypes)

Specified by:

setSelectableTypes in interface com.nomagic.magicdraw.properties.ElementFilterProperty

setDisplayableTypes

public void setDisplayableTypes(@CheckForNull
                                java.util.Collection displayableTypes)

Specified by:

setDisplayableTypes in interface com.nomagic.magicdraw.properties.ElementFilterProperty

setContainment

public void setContainment(boolean containment)

Specified by:

setContainment in interface com.nomagic.magicdraw.properties.ElementFilterProperty

setOrdered

public void setOrdered(boolean ordered)

Specified by:

setOrdered in interface com.nomagic.magicdraw.properties.ElementFilterProperty