Package com.nomagic.magicdraw.core.options

Class AbstractPropertyOptionsGroup

java.lang.Object
com.nomagic.magicdraw.core.options.OptionsGroup
com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
AbstractDiagramLayouterOptionsGroup, com.nomagic.magicdraw.core.options.VersionedOptionsGroup
@OpenApi public abstract class AbstractPropertyOptionsGroup extends OptionsGroup
Manages editing of properties as options in an application.
See Also:

  • Constructor Details

    • AbstractPropertyOptionsGroup

      @OpenApi public AbstractPropertyOptionsGroup(String id, @CheckForNull PropertyManager propertyManager, boolean visible)
      Constructs property options group.
      Parameters:
      id - id of the group.
      propertyManager - property options managed by this group.
      visible - indicates if group is visible to the user.

    • AbstractPropertyOptionsGroup

      @OpenApi public AbstractPropertyOptionsGroup(PropertyManager propertyManager)
      Constructs property options group.
      Parameters:
      propertyManager - property options managed by this group.

    • AbstractPropertyOptionsGroup

      @OpenApi public AbstractPropertyOptionsGroup(String id)
      Constructs property options group.
      Parameters:
      id - id of the group.

  • Method Details

    • setDefaultValues

      @OpenApi public void setDefaultValues()
      Sets default values for the properties contained in this group. Overriding classes should set default values to the properties.

    • getOptions

      @OpenApi public PropertyManager getOptions()
      Gets properties managed by options.
      Returns:
      properties managed by options.

    • getVisibleOptions

      @OpenApi public PropertyManager getVisibleOptions()
      Gets properties which are visible to the user.
      Returns:
      properties which are visible to the user.

    • setOptions

      @OpenApi protected void setOptions(PropertyManager propertyManager)
      Sets properties for options.
      Parameters:
      propertyManager - property manager to set.

    • getProperty

      @CheckForNull @OpenApi public Property getProperty(String name)
      Gets property by name.
      Parameters:
      name - name of the property.
      Returns:
      property found by name.

    • addProperty

      @OpenApi public void addProperty(Property property)
      Adds property to this group. DescriptionID will be reset. To add property with description use addProperty(Property, String) method.
      Parameters:
      property - property to be added.

    • addProperty

      @OpenApi public void addProperty(Property property, boolean generateDescription)
      Adds property to this group. Property description ID will be generated or reset depending on generateDescription parameter value. If generateDescription = true, standard description resource ID will be generated by MagicDraw. If generateDescription = false, description ID will be set to null. To add property with its own description ID use addProperty(Property, String) method
      Parameters:
      property - property to add.
      generateDescription - true if description for property must be generated. Otherwise, description ID will be reset.

    • addProperty

      @OpenApi public void addProperty(Property property, String descriptionID)
      Adds property with given descriptionID.
      Parameters:
      property - property to be added.
      descriptionID - descriptionID for property.

    • addInvisibleProperty

      @OpenApi public void addInvisibleProperty(Property property)
      Adds a property which is invisible to the user.
      Parameters:
      property - property to add.

    • removeProperty

      @OpenApi public void removeProperty(String name)
      Removes a property by name.
      Parameters:
      name - name by which to remove the property.

    • setPropertyInvisible

      @OpenApi public void setPropertyInvisible(String id, boolean invisible)
      Changes visibility flag to the property.
      Parameters:
      id - id of the property for which to change visibility.
      invisible - visibility flag value.

    • setPropertiesInvisible

      @OpenApi public void setPropertiesInvisible(String[] ids, boolean invisible)
      Sets visibility flag for an array of properties.
      Parameters:
      ids - ids of properties for which to change visibility flag.
      invisible - visibility flag value.