de.cau.cs.kieler.karma
Interface IRenderingProvider

All Known Implementing Classes:
KaomPortProvider, KaomRenderingProvider, KEGFigureProvider, PtolemyStateMachineProvider, SyncchartsConnectionFigureProvider, SyncchartsFigureProvider

public interface IRenderingProvider

Class for providing figures represented by a string.

Rating red

Nested Class Summary
static class IRenderingProvider.CollapseStatus
           
 
Method Summary
 IBorderItemLocator getBorderItemLocatorByString(String input, IFigure parentFigure, Object locator, EObject object, IRenderingProvider.CollapseStatus collapseStatus)
          Returns a BorderItemLocator according to a given string.
 IFigure getFigureByString(String input, IFigure oldFigure, EObject object, EditPart part)
          Returns a figure according to a given string.
 LayoutManager getLayoutManagerByString(String input, LayoutManager oldLayoutManager, EObject object)
          Returns a LayoutManager according to a given string.
 Dimension getSizeByString(String input, EObject object, EditPart part)
          Returns the size of a figure according to a given string.
 

Method Detail

getFigureByString

IFigure getFigureByString(String input,
                          IFigure oldFigure,
                          EObject object,
                          EditPart part)
Returns a figure according to a given string.

Parameters:
input - a string representation of the figure
oldFigure - the old figure
object - the model element
part - the corresponding editPart
Returns:
the figure

getSizeByString

Dimension getSizeByString(String input,
                          EObject object,
                          EditPart part)
Returns the size of a figure according to a given string. The fixed size given in the extension point has priority over the one given here. If no fixed size shall be set or the fixed size is defined in the plugin extension, this method returns null. The string input is the same as the one for getFigureByString.

Parameters:
input - a string representation of the figure
object - the model element
part - the corresponding editPart
Returns:
the fixed size, or null if no fixed size shall be set

getLayoutManagerByString

LayoutManager getLayoutManagerByString(String input,
                                       LayoutManager oldLayoutManager,
                                       EObject object)
Returns a LayoutManager according to a given string.

Parameters:
input - a string representation of the LayoutManager
oldLayoutManager - the old LayoutManager
object - the model element
Returns:
the new LayoutManager

getBorderItemLocatorByString

IBorderItemLocator getBorderItemLocatorByString(String input,
                                                IFigure parentFigure,
                                                Object locator,
                                                EObject object,
                                                IRenderingProvider.CollapseStatus collapseStatus)
Returns a BorderItemLocator according to a given string.

Parameters:
input - a string representation of the BorderItemLocator
parentFigure - the parentFigure
locator - the old BorderItemLocator
object - the model element
Returns:
the new BorderItemLocator