com.nomagic.magicdraw.properties

Class Style

java.lang.Object

com.nomagic.magicdraw.properties.Style

All Implemented Interfaces:

com.nomagic.magicdraw.core.project.options.PersistentStyle, PropertyVisitorAcceptor, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

@OpenApiAll
public class Style
extends java.lang.Object
implements java.lang.Cloneable, PropertyVisitorAcceptor, java.beans.PropertyChangeListener, com.nomagic.magicdraw.core.project.options.PersistentStyle

Style stores and manages a set of PropertyManagers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGE_STYLE_PROPERTY Name of property fired on some style change.
static java.lang.String	CHANGE_STYLE_PROPERTY_VALUE
static java.lang.String	MERGED
static java.lang.String	MERGED_PRE1704
static java.lang.String	SHARED

Constructor Summary

Constructors

Constructor and Description
Style() Constructs new Style.

Method Summary

Modifier and Type	Method and Description
void	accept(PropertyVisitor visitor) Accepts the given visitor.
void	addManager(PropertyManager manager) Adds given property manager.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Registers the listener to the element.
void	append(Style s) Adds all managers from given style to this style.
void	appendExtendedManagers(Style s)
void	apply(Style s) Applies all managers from given style to the existing managers here.
void	changeProperty(Property p) Replaces existing property in all managers with the given one.
java.lang.Object	clone() /** Creates and returns a copy of this style.
protected void	cloneManagers(Style newS)
static PropertyManager	findPropertyManagerWithPath(Style findIn, java.util.ArrayList<PropertyManager> path)
static PropertyManager	findPropertyManagerWithSamePath(Style findIn, PropertyManager find) Finds same property manager(with same path) in given style.
static void	generateDefaultDescriptionID(Style style) Generate default description id.
void	generateID()
java.lang.String	getClassType() Returns property class type.
java.lang.String	getID()
PropertyManager	getManager(java.lang.String name) Returns property manager with given name.
int	getManagerCount() Returns managers count.
java.util.Collection<PropertyManager>	getManagers() Returns a collection of all managers.
java.util.List<PropertyManager>	getManagersFromParent(PropertyManager root)
java.lang.String	getName() Returns the name of the style.
java.util.List<PropertyManager>	getOrderedManagers() Returns collection of managers sorted by name.
boolean	isDefault() Is this style a default one?
boolean	isDiagramStyle()
boolean	isEqual(Style style) Checks if given style has same property managers with same values.
boolean	isSnapshotStyleForDiagramSymbols()
void	propertyChange(java.beans.PropertyChangeEvent evt) On CHANGE_STYLE_PROPERTY property change takes the manager from property's new Value and replaces itself properties with properties from this manager.
void	removeManager(PropertyManager manager) Removes given property manager.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Unregisters the given listener from the element.
void	setDefault(boolean def) Sets default flag value.
void	setID(java.lang.String id) Set Id
void	setManagers(java.util.Collection<PropertyManager> managers) Sets the collection of all managers.
void	setName(java.lang.String name) Set the name of the style.
java.lang.String	toString() Returns a string representation of the style.

Methods inherited from class java.lang.Object

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

Field Detail

CHANGE_STYLE_PROPERTY

public static final java.lang.String CHANGE_STYLE_PROPERTY

Name of property fired on some style change.

See Also:

Constant Field Values

CHANGE_STYLE_PROPERTY_VALUE

public static final java.lang.String CHANGE_STYLE_PROPERTY_VALUE

See Also:

Constant Field Values

SHARED

public static final java.lang.String SHARED

See Also:

Constant Field Values

MERGED

public static final java.lang.String MERGED

See Also:

Constant Field Values

MERGED_PRE1704

public static final java.lang.String MERGED_PRE1704

See Also:

Constant Field Values

Constructor Detail

Style

public Style()

Constructs new Style. Style will have name "default", but it will not be default.

Method Detail

addManager

public void addManager(@CheckForNull
                       PropertyManager manager)

Adds given property manager.

Parameters:

manager - the manager to add.

removeManager

public void removeManager(PropertyManager manager)

Removes given property manager.

Parameters:

manager - the manager to remove.

getManagerCount

public int getManagerCount()

Returns managers count.

Returns:

count of managers.

setManagers

public void setManagers(java.util.Collection<PropertyManager> managers)

Sets the collection of all managers.

Parameters:

managers - a collection of new managers.

getName

public java.lang.String getName()

Returns the name of the style.

Returns:

name of the style.

setName

public void setName(java.lang.String name)

Set the name of the style.

Parameters:

name - the new name of the style.

toString

public java.lang.String toString()

Returns a string representation of the style. Used for debug.

Overrides:

toString in class java.lang.Object

Returns:

the string representation.

setDefault

public void setDefault(boolean def)

Sets default flag value.

Parameters:

def - new flag value.

isDefault

public boolean isDefault()

Is this style a default one?

Returns:

default flag value.

clone

public java.lang.Object clone()

/** Creates and returns a copy of this style. Does deep clone.

Overrides:

clone in class java.lang.Object

Returns:

the clone of this style.

cloneManagers

protected void cloneManagers(Style newS)

getManagers

public java.util.Collection<PropertyManager> getManagers()

Returns a collection of all managers.

Returns:

all managers.

getOrderedManagers

public java.util.List<PropertyManager> getOrderedManagers()

Returns collection of managers sorted by name.

Returns:

collection of managers sorted by name.

getManager

@CheckForNull
public PropertyManager getManager(java.lang.String name)

Returns property manager with given name.

Parameters:

name - the name of manager.

Returns:

manager with given name or null.

accept

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

Accepts the given visitor.

Specified by:

accept in interface PropertyVisitorAcceptor

Parameters:

visitor - the PropertyVisitor.

Throws:

java.lang.Exception

getClassType

public java.lang.String getClassType()

Returns property class type.

Specified by:

getClassType in interface PropertyVisitorAcceptor

Returns:

PropertyID.SIMPLE_STYLE

See Also:

PropertyID.SIMPLE_STYLE

append

public void append(Style s)

Adds all managers from given style to this style. If some manager exists in given style, but does not exist in this style - clone this manager and add. If some manager exists in given style and exists in this style - append properties from given manager to this manager.

Parameters:

s - the given style.

apply

public void apply(@Nonnull
                  Style s)

Applies all managers from given style to the existing managers here. If some manager exists in given style, but does not exist in this style - do nothing.

Parameters:

s - the given style.

appendExtendedManagers

public void appendExtendedManagers(@Nonnull
                                   Style s)

isDiagramStyle

public boolean isDiagramStyle()

Returns:

if it is diagram style

changeProperty

public void changeProperty(Property p)

Replaces existing property in all managers with the given one.

Parameters:

p - the given property.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

On CHANGE_STYLE_PROPERTY property change takes the manager from property's new Value and replaces itself properties with properties from this manager.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - PropertyChangeEvent.

getManagersFromParent

public java.util.List<PropertyManager> getManagersFromParent(@CheckForNull
                                                             PropertyManager root)

findPropertyManagerWithSamePath

@CheckForNull
public static PropertyManager findPropertyManagerWithSamePath(Style findIn,
                                                                            PropertyManager find)

Finds same property manager(with same path) in given style.

Parameters:

findIn - style where find manager.

find - manager to find.

Returns:

found manager, or null if not found.

findPropertyManagerWithPath

@CheckForNull
public static PropertyManager findPropertyManagerWithPath(Style findIn,
                                                                        java.util.ArrayList<PropertyManager> path)

generateID

public void generateID()

getID

public java.lang.String getID()

Returns:

Returns the iD. Can return null if ID was not generated. ID is generated only for styles used for not loaded diagrams.

setID

public void setID(java.lang.String id)

Set Id

Parameters:

id - given ID.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Registers the listener to the element. The given listener will get notifications about property changes in this element.

Parameters:

listener - the PropertyChangeListener to be added.

See Also:

PropertyChangeSupport

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Unregisters the given listener from the element. The given listener will not get any notifications about property changes in this element.

Parameters:

listener - the PropertyChangeListener to be removed.

See Also:

PropertyChangeSupport

generateDefaultDescriptionID

public static void generateDefaultDescriptionID(Style style)

Generate default description id.

Parameters:

style - style

isSnapshotStyleForDiagramSymbols

public boolean isSnapshotStyleForDiagramSymbols()

Returns:

true if style is clone used for diagram style preserving.

isEqual

public boolean isEqual(Style style)

Checks if given style has same property managers with same values.

Parameters:

style - given style.

Returns:

true if given style has same values as this style.