com.logabit.xlayout

Class XLayoutFactory

java.lang.Object

com.logabit.xlayout.XLayoutFactory

public class XLayoutFactory
extends Object

Is reposible to read the default control handler configuration and creates control handler configuration objects out of that. After instanciating and initialization XLayout instances can be created using createXLayout(). It's also possible to add user defined control handlers either by using one of the register... methods or by placing a control handler XML configuration file handler-config.xml into the classpath root and register all user defined control handlers here. This file will automaticaly picked up at instanciation time of the factory.

Method Summary

Modifier and Type	Method and Description
boolean	containsControlHandler(String name) Returns whether a control handler with given name is already registered.
XLayout	createXLayout() Creates a new XLayout instance and initializes it with registered handlers.
void	destroy()
ControlHandlerConfig	getControlHandlerConfig(String name) Returns the control handler configuration for the given control handler or null if no such configuration for the given name exists.
static XLayoutFactory	getFactory()
static XLayoutFactory	getFactory(ClassLoader resourceClassLoader)
void	registerControlHandler(ControlHandlerConfig handlerConfig, boolean overwrite) Registers an new handler using a given configuration.
void	registerControlHandler(String name, com.logabit.xlayout.handlers.IControlHandler handler, boolean overwrite) Registers a new control handler.
void	registerControlHandlers(File file, boolean overwrite) Reads from an xml file and registers all handlers placed in this file.
void	registerControlHandlers(InputStream is, String hint, boolean overwrite) Reads from an xml input stream and registers all handlers placed in this file.
void	registerControlHandlers(List<ControlHandlerConfig> handlerConfigs, boolean overwrite) Registers new handlers using the given configuration objects.
void	removeControlHandler(String name) Removes the handler with the given name from the list of registered handlers.

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static XLayoutFactory getFactory(ClassLoader resourceClassLoader)

getFactory

public static XLayoutFactory getFactory()

destroy

public void destroy()

createXLayout

public XLayout createXLayout()

Creates a new XLayout instance and initializes it with registered handlers.

Returns:

Fresh XLayout instance.

registerControlHandler

public void registerControlHandler(String name,
                                   com.logabit.xlayout.handlers.IControlHandler handler,
                                   boolean overwrite)

Registers a new control handler. NOTE: The required handlers must be registered before the createXLayout method is called!

Parameters:

name - The name of handler.

handler - The handler instance.

overwrite - If this flag is true, an already existing handler with that name will be overwritten. If this flag is false and a handler with that name already exists, nothing happens.

removeControlHandler

public void removeControlHandler(String name)

Removes the handler with the given name from the list of registered handlers. NOTE: It is possible that the handler is still in use by a XLayout instance created before!

Parameters:

name -

registerControlHandler

public void registerControlHandler(ControlHandlerConfig handlerConfig,
                                   boolean overwrite)

Registers an new handler using a given configuration.

Parameters:

handlerConfig - The handler configuration.

overwrite - If true, overwrites an already existing handler with that name.

registerControlHandlers

public void registerControlHandlers(List<ControlHandlerConfig> handlerConfigs,
                                    boolean overwrite)

Registers new handlers using the given configuration objects.

Parameters:

handlerConfigs - The list of configurations.

overwrite - If true, overwrites an already existing handler with that name.

registerControlHandlers

public void registerControlHandlers(File file,
                                    boolean overwrite)

Reads from an xml file and registers all handlers placed in this file. The general structur of this xml file must be: ...

Parameters:

file - The xml configuration file.

overwrite - If true, overwrites an already existing handler with that name.

registerControlHandlers

public void registerControlHandlers(InputStream is,
                                    String hint,
                                    boolean overwrite)

Reads from an xml input stream and registers all handlers placed in this file. The general structur of this xml file must be: ...

Parameters:

is - The xml configuration input stream.

hint - A hint for the input stream which says where the stream comes from.

overwrite - If true, overwrites an already existing handler with that name.

getControlHandlerConfig

public ControlHandlerConfig getControlHandlerConfig(String name)

Returns the control handler configuration for the given control handler or null if no such configuration for the given name exists.

Parameters:

name - - The name of the control handler.

Returns:

The control handler configuration object or null.

containsControlHandler

public boolean containsControlHandler(String name)

Returns whether a control handler with given name is already registered.

Parameters:

name -

Returns: