Docmosis API 4.5.0

com.docmosis.template.population.render
Class RendererRegistry

java.lang.Object
  extended bycom.docmosis.template.population.render.RendererRegistry

public class RendererRegistry
extends Object

A registry of FieldRenderers that can be applied to template fields


Constructor Summary
RendererRegistry()
           
RendererRegistry(RendererRegistry other)
          Create a stand alone copy of this registry.
 
Method Summary
static FieldRenderer clearDefaultRendererByClass(Class forClass)
          Remove any renderer registered against the given class.
static FieldRenderer clearDefaultRendererByName(String name)
          Remove any renderer registered against the given name.
 FieldRenderer findByClass(Class forClass)
          Look for a renderer by Class first in this instance and if not found (or null returned) look in the default renderers.
 FieldRenderer findByName(String name)
          Look for a renderer by name first in this instance and if not found (or null returned) look in the default renderers.
static FieldRenderer getDefaultRendererByClass(Class forClass)
          Get the default renderer for the given class.
static FieldRenderer getDefaultRendererByName(String name)
           
 FieldRenderer getRendererByClass(Class forClass)
           
 FieldRenderer getRendererByName(String name)
           
static void initialise()
           
static void setDefaultRendererByClass(Class forClass, FieldRenderer renderer)
          Register a default renderer for Objects of the given type.
static void setDefaultRendererByClassAndName(Class forClass, String name, FieldRenderer renderer)
           
static void setDefaultRendererByName(String name, FieldRenderer renderer)
           
 void setRendererByClass(Class forClass, FieldRenderer renderer)
          Set a renderer in this instance for the given class type.
 void setRendererByClassAndName(Class forClass, String name, FieldRenderer renderer)
          Set a renderer in this instance against the given name and Class at the same time.
 void setRendererByName(String name, FieldRenderer renderer)
          Set a renderer in this instance against the given name.
static void shutdown()
          Release all default renderers held
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RendererRegistry

public RendererRegistry()

RendererRegistry

public RendererRegistry(RendererRegistry other)
Create a stand alone copy of this registry. Note that the Default Settings are common across all instances so calling any setDefault* method affects all instances.

Parameters:
other - the registry to copy
Method Detail

setRendererByClass

public void setRendererByClass(Class forClass,
                               FieldRenderer renderer)
Set a renderer in this instance for the given class type.

Parameters:
forClass - the class against which the renderer is registered.
renderer - the renderer

setRendererByName

public void setRendererByName(String name,
                              FieldRenderer renderer)
Set a renderer in this instance against the given name.

Parameters:
name - the name against which the renderer is registered.
renderer - the renderer

setRendererByClassAndName

public void setRendererByClassAndName(Class forClass,
                                      String name,
                                      FieldRenderer renderer)
Set a renderer in this instance against the given name and Class at the same time. If the forClass or name are null, the renderer is not registered against that item.

Parameters:
forClass - the class against which the renderer is registered.
name - the name against which the renderer is registered.
renderer - the renderer

getRendererByName

public FieldRenderer getRendererByName(String name)

getRendererByClass

public FieldRenderer getRendererByClass(Class forClass)

getDefaultRendererByClass

public static FieldRenderer getDefaultRendererByClass(Class forClass)
Get the default renderer for the given class. If the given forClass is null, null is returned.

Parameters:
forClass - the class for which to obtain the renderer
Returns:
null if the class has no defined renderer.

getDefaultRendererByName

public static FieldRenderer getDefaultRendererByName(String name)

setDefaultRendererByClass

public static void setDefaultRendererByClass(Class forClass,
                                             FieldRenderer renderer)
Register a default renderer for Objects of the given type. If a renderer is already registered for a given type, it will be overridden. If the given forClass is null, nothing is done.

Parameters:
forClass - the class against which to register the renderer
renderer - the renderer for instances of the given class

setDefaultRendererByName

public static void setDefaultRendererByName(String name,
                                            FieldRenderer renderer)

setDefaultRendererByClassAndName

public static void setDefaultRendererByClassAndName(Class forClass,
                                                    String name,
                                                    FieldRenderer renderer)

clearDefaultRendererByClass

public static FieldRenderer clearDefaultRendererByClass(Class forClass)
Remove any renderer registered against the given class. If the given forClass is null, nothing is done and null is returned.

Parameters:
forClass - the class for which to remove the renderer association
Returns:
the previously associated renderer or null

clearDefaultRendererByName

public static FieldRenderer clearDefaultRendererByName(String name)
Remove any renderer registered against the given name. If the given name is null, nothing is done and null is returned.

Parameters:
name - the name for which to remove the renderer association
Returns:
the previously associated renderer or null

findByName

public FieldRenderer findByName(String name)
Look for a renderer by name first in this instance and if not found (or null returned) look in the default renderers.

Parameters:
name - the name of the renderer to find
Returns:
a field renderer or null

findByClass

public FieldRenderer findByClass(Class forClass)
Look for a renderer by Class first in this instance and if not found (or null returned) look in the default renderers.

Parameters:
forClass - the class against which the renderer is registered
Returns:
a field renderer or null

shutdown

public static void shutdown()
Release all default renderers held


initialise

public static void initialise()

Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.