org.modelio.api.modelio.diagram

Interface IDiagramCustomizer

All Known Implementing Classes:

DefaultDiagramCustomizer

public interface IDiagramCustomizer

This interface is used to define a diagram palette for a module.

Method Summary

Modifier and Type	Method and Description
void	fillPalette(PaletteRoot paletteRoot) Define the palette content by adding groups and tools in it. Tools can be custom (i.e.
default IDGDynamicDecorator	getDynamicDecorator() Optional decorator for diagram graphics in the customized diagram.
java.util.Map<java.lang.String,java.lang.String>	getParameters()
void	initialize(IModule module, java.util.List<PaletteEntry> tools, java.util.Map<java.lang.String,java.lang.String> hParameters, boolean keepBasePalette) Initialize the customizer.
boolean	keepBasePalette() Indicates whether the 'standard' content of the diagram palette must be kept or flushed when opening this stereotyped diagram.

Method Detail

keepBasePalette

boolean keepBasePalette()

Indicates whether the 'standard' content of the diagram palette must be kept or flushed when opening this stereotyped diagram.

Returns:

true when the 'standard' content of the diagram palette must be kept.

fillPalette

void fillPalette(PaletteRoot paletteRoot)

Define the palette content by adding groups and tools in it.
Tools can be custom (i.e. added by modules) or standard tools, usually named after their metaclass (like 'CREATE_NOTE').

Parameters:

root - The root PaletteEntry for the palette model.

initialize

void initialize(IModule module,
                java.util.List<PaletteEntry> tools,
                java.util.Map<java.lang.String,java.lang.String> hParameters,
                boolean keepBasePalette)

Initialize the customizer. Called right after the constructor. Passed values are collected from the module.xml definition of the customizer.

Parameters:

module - the module this diagram custimizer comes from.

tools - tools defined in the diagram definition.

hParameters - parameters defined in the diagram definition.

keepBasePalette - whether or not 'standard' content of the diagram palette should be kept.

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

Returns:

the handler parameters as defined in the module.xml file

getDynamicDecorator

default IDGDynamicDecorator getDynamicDecorator()

Optional decorator for diagram graphics in the customized diagram.

With a decorator, it becomes possible to dynamically overwrite graphical property on any unmasked element.

Returns:

an instance of IDGDynamicDecorator.

Since:

3.6