Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.argouml.notation
Class NotationProviderFactory2

java.lang.Object
  extended by org.argouml.notation.NotationProviderFactory2

public final class NotationProviderFactory2
extends java.lang.Object

The NotationProviderFactory2 is a singleton, since it is the accesspoint for all Figs to access the textual representation of modelobjects, and since plugin modules can add extra languages.

Field Summary
static int TYPE_ACTIONSTATE
          TYPE_ACTIONSTATE the text shown in an actionstate.
static int TYPE_ASSOCIATION_END_NAME
          The text shown at the association end that represents the role.
static int TYPE_ASSOCIATION_NAME
          The text shown for the association role name.
static int TYPE_ASSOCIATION_ROLE
          The text shown for the association role name.
static int TYPE_ATTRIBUTE
          TYPE_ATTRIBUTE the text shown in a attribute compartment (1 attrib only).
static int TYPE_CALLSTATE
          TYPE_CALLSTATE the text shown on a callstate's state.
static int TYPE_CLASSIFIERROLE
          TYPE_CLASSIFIERROLE the text shown on a classifierrole.
static int TYPE_COMPONENTINSTANCE
          TYPE_COMPONENTINSTANCE the text shown on a componentInstance.
static int TYPE_ENUMERATION_LITERAL
          The text shown for an enumeration literal.
static int TYPE_EXTENSION_POINT
          TYPE_EXTENSION_POINT the text shown on a usecase representing the extensionpoint.
static int TYPE_MESSAGE
          TYPE_MESSAGE the text shown on a Message in a Collaborations diagram.
static int TYPE_MULTIPLICITY
          The text shown for a multiplicity.
static int TYPE_NAME
          TYPE_NAME the name of the modelelement, e.g.
static int TYPE_NODEINSTANCE
          TYPE_NODEINSTANCE the text shown on a componentInstance.
static int TYPE_OBJECT
          TYPE_OBJECT the text shown on an object.
static int TYPE_OBJECTFLOWSTATE_STATE
          TYPE_OBJECTFLOWSTATE_STATE the text shown on a objectflowstate's state.
static int TYPE_OBJECTFLOWSTATE_TYPE
          TYPE_TYPE_OBJECTFLOWSTATE_TYPE the text shown on a objectflowstate's type, i.e.
static int TYPE_OPERATION
          TYPE_OPERATION the text shown in a operation compartment (1 oper only).
static int TYPE_SD_MESSAGE
          TYPE_MESSAGE the text shown on a Message in a Collaborations diagram.
static int TYPE_STATEBODY
          TYPE_STATEBODY the multiline text shown inside the state body.
static int TYPE_TRANSITION
          TYPE_TRANSITION the main text shown above the transition.
 
Method Summary
 void addNotationProvider(int type, NotationName notationName, java.lang.Class provider)
           
static NotationProviderFactory2 getInstance()
           
 NotationProvider getNotationProvider(int type, java.lang.Object object)
          Deprecated. for 0.27.2 by tfmorris. Use getNotationProvider(int, Object, NotationName).
 NotationProvider getNotationProvider(int type, java.lang.Object object, NotationName name)
          Get a NotationProvider for the current project.
 NotationProvider getNotationProvider(int type, java.lang.Object object, java.beans.PropertyChangeListener listener, NotationName name)
          Get a NotationProvider for the current project.
 boolean removeNotation(NotationName notationName)
          We need this to remove modules.
static void setCurrentLanguage(java.lang.String theCurrentLanguage)
          Deprecated. for 0.27.2 by tfmorris. Callers should manage the language that they want explicitly.
 void setDefaultNotation(NotationName notationName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_NAME

public static final int TYPE_NAME
TYPE_NAME the name of the modelelement, e.g. class, package, state

See Also:
Constant Field Values

TYPE_TRANSITION

public static final int TYPE_TRANSITION
TYPE_TRANSITION the main text shown above the transition.

See Also:
Constant Field Values

TYPE_STATEBODY

public static final int TYPE_STATEBODY
TYPE_STATEBODY the multiline text shown inside the state body.

See Also:
Constant Field Values

TYPE_ACTIONSTATE

public static final int TYPE_ACTIONSTATE
TYPE_ACTIONSTATE the text shown in an actionstate.

See Also:
Constant Field Values

TYPE_ATTRIBUTE

public static final int TYPE_ATTRIBUTE
TYPE_ATTRIBUTE the text shown in a attribute compartment (1 attrib only).

See Also:
Constant Field Values

TYPE_OPERATION

public static final int TYPE_OPERATION
TYPE_OPERATION the text shown in a operation compartment (1 oper only).

See Also:
Constant Field Values

TYPE_OBJECT

public static final int TYPE_OBJECT
TYPE_OBJECT the text shown on an object.

See Also:
Constant Field Values

TYPE_COMPONENTINSTANCE

public static final int TYPE_COMPONENTINSTANCE
TYPE_COMPONENTINSTANCE the text shown on a componentInstance.

See Also:
Constant Field Values

TYPE_NODEINSTANCE

public static final int TYPE_NODEINSTANCE
TYPE_NODEINSTANCE the text shown on a componentInstance.

See Also:
Constant Field Values

TYPE_OBJECTFLOWSTATE_TYPE

public static final int TYPE_OBJECTFLOWSTATE_TYPE
TYPE_TYPE_OBJECTFLOWSTATE_TYPE the text shown on a objectflowstate's type, i.e. its classifier name.

See Also:
Constant Field Values

TYPE_OBJECTFLOWSTATE_STATE

public static final int TYPE_OBJECTFLOWSTATE_STATE
TYPE_OBJECTFLOWSTATE_STATE the text shown on a objectflowstate's state.

See Also:
Constant Field Values

TYPE_CALLSTATE

public static final int TYPE_CALLSTATE
TYPE_CALLSTATE the text shown on a callstate's state.

See Also:
Constant Field Values

TYPE_CLASSIFIERROLE

public static final int TYPE_CLASSIFIERROLE
TYPE_CLASSIFIERROLE the text shown on a classifierrole.

See Also:
Constant Field Values

TYPE_MESSAGE

public static final int TYPE_MESSAGE
TYPE_MESSAGE the text shown on a Message in a Collaborations diagram.

See Also:
Constant Field Values

TYPE_EXTENSION_POINT

public static final int TYPE_EXTENSION_POINT
TYPE_EXTENSION_POINT the text shown on a usecase representing the extensionpoint.

See Also:
Constant Field Values

TYPE_ASSOCIATION_END_NAME

public static final int TYPE_ASSOCIATION_END_NAME
The text shown at the association end that represents the role.

See Also:
Constant Field Values

TYPE_ASSOCIATION_ROLE

public static final int TYPE_ASSOCIATION_ROLE
The text shown for the association role name.

See Also:
Constant Field Values

TYPE_ASSOCIATION_NAME

public static final int TYPE_ASSOCIATION_NAME
The text shown for the association role name.

See Also:
Constant Field Values

TYPE_MULTIPLICITY

public static final int TYPE_MULTIPLICITY
The text shown for a multiplicity.

See Also:
Constant Field Values

TYPE_ENUMERATION_LITERAL

public static final int TYPE_ENUMERATION_LITERAL
The text shown for an enumeration literal.

See Also:
Constant Field Values

TYPE_SD_MESSAGE

public static final int TYPE_SD_MESSAGE
TYPE_MESSAGE the text shown on a Message in a Collaborations diagram.

See Also:
Constant Field Values
Method Detail

getInstance

public static NotationProviderFactory2 getInstance()
Returns:
returns the singleton instance

getNotationProvider

@Deprecated
public NotationProvider getNotationProvider(int type,
                                                       java.lang.Object object)
Deprecated. for 0.27.2 by tfmorris. Use getNotationProvider(int, Object, NotationName).

Get a NotationProvider for the current language.

Parameters:
type - the provider type
object - the constructor parameter
Returns:
the provider

getNotationProvider

public NotationProvider getNotationProvider(int type,
                                            java.lang.Object object,
                                            NotationName name)
Get a NotationProvider for the current project.

If there is any reason for failure, null is returned - no exception is thrown. The caller is supposed to deal with receiving null.

Parameters:
type - the provider type
object - the constructor parameter
name - the name of the notation language to use
Returns:
the provider, or null if there was any failure

getNotationProvider

public NotationProvider getNotationProvider(int type,
                                            java.lang.Object object,
                                            java.beans.PropertyChangeListener listener,
                                            NotationName name)
Get a NotationProvider for the current project. This also initializes the listeners.

Parameters:
type - the provider type
object - the constructor parameter
listener - the fig that refreshes after the NotationProvider has changed
name - the name of the notation language to use
Returns:
the provider

addNotationProvider

public void addNotationProvider(int type,
                                NotationName notationName,
                                java.lang.Class provider)
Parameters:
type - the provider type
notationName - the name of the notation (language)
provider - the provider

setDefaultNotation

public void setDefaultNotation(NotationName notationName)
Parameters:
notationName - the UML notation that is to be used as default if no other is found

removeNotation

public boolean removeNotation(NotationName notationName)
We need this to remove modules.

Parameters:
notationName - the notation to be removed
Returns:
true if the notation was removed

setCurrentLanguage

@Deprecated
public static void setCurrentLanguage(java.lang.String theCurrentLanguage)
Deprecated. for 0.27.2 by tfmorris. Callers should manage the language that they want explicitly.

Set the default notation language for all users of this factory.

Parameters:
theCurrentLanguage - the currentLanguage to set
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
ArgoUML © 1996-2006ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook