org.openjump.jump.workbench.ui.renderer
Interface IRendererFactory

All Known Implementing Classes:
RendererFactory

public interface IRendererFactory


Method Summary
 void addRendererFactoryTool(java.lang.Object argContentID, IRendererFactoryTool argTool)
          Call this method to add a RendererFactoryTool to this RendererFactory.
 void addRendererFactoryTool(java.lang.String argClassName, IRendererFactoryTool argTool)
          Call this method to add a RendererFactoryTool to this RendererFactory.
 com.vividsolutions.jump.workbench.ui.renderer.Renderer getRendererForClassName(java.lang.String argClassName, java.lang.Object argContentID, com.vividsolutions.jump.workbench.ui.LayerViewPanel argPanel)
          Returns the appropriate renderer for the class identified by the String passed as an parameter.
 com.vividsolutions.jump.workbench.ui.renderer.Renderer getRendererForObject(java.lang.Object argContentID, com.vividsolutions.jump.workbench.ui.LayerViewPanel argPanel)
          Returns the appropriate renderer for the object passed as an parameter.
 boolean hasARendererForClass(java.lang.Object argContentID)
          Returns true if this RenderingFactory contains a IRendererFactoryTool that will return an implementation of the Renderer interface for the class.
 boolean hasARendererForClass(java.lang.String argClassName)
          Returns true if this RenderingFactory contains a IRendererFactoryTool that will return an implementation of the Renderer interface for the class.
 void removeRendererFactoryTool(java.lang.Object ContentID)
          Call this method to remove the IRendererFactoryTool from this RendererFacotry.
 void removeRendererFactoryTool(java.lang.String argClassName)
          Call this method to remove the IRendererFactoryTool from this RendererFacotry.
 

Method Detail

getRendererForClassName

com.vividsolutions.jump.workbench.ui.renderer.Renderer getRendererForClassName(java.lang.String argClassName,
                                                                               java.lang.Object argContentID,
                                                                               com.vividsolutions.jump.workbench.ui.LayerViewPanel argPanel)
Returns the appropriate renderer for the class identified by the String passed as an parameter.

Parameters:
String - - The fully qualified class name for which you want a Renderer.
Returns:
Renderer - An implementation of the Renderer interface that can be used to paint an object of the class type pased as an argument to this method.

getRendererForObject

com.vividsolutions.jump.workbench.ui.renderer.Renderer getRendererForObject(java.lang.Object argContentID,
                                                                            com.vividsolutions.jump.workbench.ui.LayerViewPanel argPanel)
Returns the appropriate renderer for the object passed as an parameter.

Parameters:
Object - - The object that you want to paint on the LayerViewPanel.
Returns:
Renderer - An implementation of the Renderer interface that can be used to paint an object pased as an argument to this method.

addRendererFactoryTool

void addRendererFactoryTool(java.lang.String argClassName,
                            IRendererFactoryTool argTool)
Call this method to add a RendererFactoryTool to this RendererFactory. These tools are used to determine which Renderer implementation should be returned for the class of the Object that is to be rendered.

Parameters:
String - - The name of the class for which this IRendererFacotryTool will return the appropriate renderer.
IRendererFactoryTool - - The tool that will return an implementation of the Renderer interface for the class.
See Also:
IRendererFactoryTool

addRendererFactoryTool

void addRendererFactoryTool(java.lang.Object argContentID,
                            IRendererFactoryTool argTool)
Call this method to add a RendererFactoryTool to this RendererFactory. These tools are used to determine which Renderer implementation should be returned for the class of the Object that is to be rendered.

Parameters:
Object - - An object whose class will be used by the IRendererFactoryTool to return the appropriate Renderer implementation.
IRendererFactoryTool - - The tool that will return an implementation of the Renderer interface for the class of the Object passed as an argument to this method.
See Also:
IRendererFactoryTool

removeRendererFactoryTool

void removeRendererFactoryTool(java.lang.String argClassName)
Call this method to remove the IRendererFactoryTool from this RendererFacotry.

Parameters:
String - - IRendererFactoryTools are identified by the class of object that they provide Renderer implementations for. To remove the IRendererFactoryTool provide the fully qualified name of the class it provides Renderers for.

removeRendererFactoryTool

void removeRendererFactoryTool(java.lang.Object ContentID)
Call this method to remove the IRendererFactoryTool from this RendererFacotry.

Parameters:
Object - - IRendererFactoryTools are identified by the class of object that they provide Renderer implementations for. To remove the IRendererFactoryTool provide an object that is an instance of the class this IRendererFactoryTool provides Renderers for.

hasARendererForClass

boolean hasARendererForClass(java.lang.String argClassName)
Returns true if this RenderingFactory contains a IRendererFactoryTool that will return an implementation of the Renderer interface for the class.

Parameters:
String - - The fully qualified name of the class for which we want to see if there is a IRendererFactoryTool.
Returns:
boolean - Returns true if the RendererFactory will provide an implementation of the Renderer interface for the class identified by the String passed to this method as an argument.

hasARendererForClass

boolean hasARendererForClass(java.lang.Object argContentID)
Returns true if this RenderingFactory contains a IRendererFactoryTool that will return an implementation of the Renderer interface for the class.

Parameters:
Object - - An object that is an instance of the class for which we want to see if there is a IRendererFactoryTool.
Returns:
boolean - Returns true if the RendererFactory will provide an implementation of the Renderer interface for the class of the object passed as an argument to this method.