org.eclipse.emf.ecp.view.model.common

Class AbstractRenderer<VELEMENT extends VElement>

java.lang.Object

org.eclipse.emf.ecp.view.model.common.AbstractRenderer<VELEMENT>

Type Parameters:

VELEMENT - the VElement this renderer is applicable for

Direct Known Subclasses:

AbstractSWTRenderer

public abstract class AbstractRenderer<VELEMENT extends VElement>
extends Object

Common super class for renderer.

Author:

Eugen Neufeld

Constructor Summary

Constructors

Constructor and Description
AbstractRenderer(VELEMENT vElement, ViewModelContext viewContext, ReportService reportService) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	checkRenderer() Checks whether the renderer is disposed and if so throws an IllegalStateException.
protected void	dispose() Disposes all resources used by the renderer.
static AbstractRenderer<? extends VElement>	getRenderer(VElement element, ViewModelContext context) Query the renderer that renders a given view model element in a particular view model context.
protected ReportService	getReportService() The SWTRendererFactory instance to use.
VELEMENT	getVElement() The VElement instance to use.
ViewModelContext	getViewModelContext() The ViewModelContext to use.
protected void	register(VElement viewModelElement) Associate me with a view model element as its renderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRenderer

public AbstractRenderer(VELEMENT vElement,
                        ViewModelContext viewContext,
                        ReportService reportService)

Default constructor.

Parameters:

vElement - the VElement to be rendered

viewContext - the ViewModelContext to use

reportService - The ReportService to use

Since:

1.6

Method Detail

getViewModelContext

public final ViewModelContext getViewModelContext()

The ViewModelContext to use.

Returns:

the ViewModelContext

getVElement

public final VELEMENT getVElement()

The VElement instance to use.

Returns:

the VElement

dispose

protected void dispose()

Disposes all resources used by the renderer. Don't forget to call super.dispose if overwriting this method.

checkRenderer

protected void checkRenderer()

Checks whether the renderer is disposed and if so throws an IllegalStateException.

Since:

1.6

getReportService

protected final ReportService getReportService()

The SWTRendererFactory instance to use.

Returns:

the SWTRendererFactory

Since:

1.6

register

protected void register(VElement viewModelElement)

Associate me with a view model element as its renderer. Multiple view-model elements may be associated with one renderer.

Parameters:

viewModelElement - the view model element to register as rendered by me

Since:

1.22

getRenderer

public static AbstractRenderer<? extends VElement> getRenderer(VElement element,
                                                               ViewModelContext context)

Query the renderer that renders a given view model element in a particular view model context.

Parameters:

element - a view model element rendered in some context

context - the view model rendering context

Returns:

the renderer, or null if the element is not rendered in this context

Since:

1.22