org.micropsi.comp.console.worldconsole
Class OverlayRendererDescriptor

java.lang.Object
  org.micropsi.comp.console.worldconsole.OverlayRendererDescriptor

public class OverlayRendererDescriptor

extends java.lang.Object

Stores information about an overlay renderer class and creates renderer instances.

Field Summary

protected ConsoleFacadeIF

console

Constructor Summary

OverlayRendererDescriptor(org.w3c.dom.Element config, ConsoleFacadeIF console)

OverlayRendererDescriptor(IOverlayRenderer renderer, java.lang.String name, int zOrder, boolean enabled, ConsoleFacadeIF console)

Method Summary

java.lang.String	getClassName()
java.lang.String	getName()
IOverlayRenderer	getRenderObject() Creates a new instance of the renderer.
int	getZOrder()
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Field Detail

console

protected ConsoleFacadeIF console

Constructor Detail

OverlayRendererDescriptor

public OverlayRendererDescriptor(org.w3c.dom.Element config,
                                 ConsoleFacadeIF console)
                          throws MicropsiException

OverlayRendererDescriptor

public OverlayRendererDescriptor(IOverlayRenderer renderer,
                                 java.lang.String name,
                                 int zOrder,
                                 boolean enabled,
                                 ConsoleFacadeIF console)

Method Detail

getClassName

public java.lang.String getClassName()

Returns:

Returns the className.

getName

public java.lang.String getName()

Returns:

Returns the name.

getZOrder

public int getZOrder()

Returns:

Returns the zOrder.

getRenderObject

public IOverlayRenderer getRenderObject()

Creates a new instance of the renderer. If anytthing goes wrong, it will log the error and return null.

Returns:

the renderer instance. May be null.

isEnabled

public boolean isEnabled()

Returns:

Returns the enabled.