com.cc.framework.ui.painter.html
Class HtmlPainterFactory

java.lang.Object
  com.cc.framework.ui.painter.PainterFactory
      com.cc.framework.ui.painter.html.HtmlPainterFactory

All Implemented Interfaces:

Factory, java.io.Serializable

public class HtmlPainterFactory

extends PainterFactory

Factory for creating HTML-Painter.

If new HTML painters are developed which belongs to the painter.html package they should be registered in this Painter. Therefore add the new class in the doCreatePainter() method or create a new subclass and override the doCreatePainter() method an register the new class at startup of the application. If you create other painters which do not belong to this package create a new package an generate an new PainterFactory class which extends the PainterFactory base class. In your application register the PainterFactory at startup. A new painter normally serves a new GUI layout.

Note: If you want to use the HTMLPainter it must be registered at startup. The best place is in your FrontControllerServlet init() method.

 public void init() throws ServletException {
 
 	super.init();
 
 	// Register all PainterFactories
 	PainterFactory.registerApplicationPainter(getServletContext(),
 			HtmlPainterFactory.instance());
 	PainterFactory.registerApplicationPainter(getServletContext(),
 			DefPainterFactory.instance());
 
 	// Log the information about the system-environment.
 	if (log.isInfoEnabled()) {
 		log.info(createApplicationInfo());
 		log.info(HttpUtil.createEnvironmentInfo());
 		log.info(HttpUtil.createContextInfo(getServletContext()));
 	}
 }
 

Since:

1.0

Version:

$Revision: 1.33 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID Serial Version UID

Fields inherited from class com.cc.framework.ui.painter.PainterFactory

Constructor Summary

HtmlPainterFactory()
Constructor for HtmlPainterFactory

Method Summary

protected ResourceMap	createResourceMap() Creates the Painters Resource Map
protected void	doCreateHeaderIncludes(javax.servlet.jsp.JspWriter writer) Creates all Include-Tags in the HTML-Pages which are necessary for the Framework to work well (css, javascripts, ...).
protected ControlPainter	doCreatePainter(PainterContext painterContext, Control ctrl) Creates a painter for the control specified in the argument.
java.lang.String	getFactoryId() Returns a unique Id for the Factory
static PainterFactory	instance() Returns the singleton instance of this class

Methods inherited from class com.cc.framework.ui.painter.PainterFactory

createActionPainter, createFramePainter, createHeaderIncludes, createPainter, createPainterContext, doCreateActionPainter, doCreateFramePainter, doCreatePainterContext, equals, getColorResource, getFactoyStack, getImageResource, getImageResource, getResources, getStringResource, getStringResource, getStringResource, hashCode, isFactorySelected, isRegisteredInScopeList, iterator, lookupFactory, registerApplicationPainter, registerApplicationPainters, registerRequestPainter, registerSessionPainter, resetApplicationPainter, resetSessionPainter, resetSessionPainter, toString, unregisterApplicationPainter, unregisterRequestPainter, unregisterSessionPainter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

Constructor Detail

HtmlPainterFactory

public HtmlPainterFactory()

Constructor for HtmlPainterFactory

Method Detail

createResourceMap

protected ResourceMap createResourceMap()

Description copied from class: PainterFactory

Creates the Painters Resource Map

Specified by:

createResourceMap in class PainterFactory

Returns:

The Resource Map

See Also:

PainterFactory.createResourceMap()

getFactoryId

public java.lang.String getFactoryId()

Returns a unique Id for the Factory

Specified by:

getFactoryId in class PainterFactory

Returns:

The id of the factory which is html for HTML-Painter

instance

public static PainterFactory instance()

Returns the singleton instance of this class

Returns:

The HtmlPainterFactory

doCreatePainter

protected ControlPainter doCreatePainter(PainterContext painterContext,
                                         Control ctrl)

Description copied from class: PainterFactory

Creates a painter for the control specified in the argument. This method must be implemented by a concrete sub class.

Note: This method will be called from the PainterFactory!

Specified by:

doCreatePainter in class PainterFactory

Parameters:

painterContext - The context of the JSP page where the control is defined. So it is possible for the painter to get the ActionMappings if required. The ActionMappings are necessary for the generation of hyperlinks.

ctrl - The instance of the control for which a painter should be created

Returns:

The painter for the specified control

See Also:

PainterFactory.doCreatePainter(com.cc.framework.ui.painter.PainterContext, com.cc.framework.ui.control.Control)

doCreateHeaderIncludes

protected void doCreateHeaderIncludes(javax.servlet.jsp.JspWriter writer)
                               throws java.io.IOException

Description copied from class: PainterFactory

Creates all Include-Tags in the HTML-Pages which are necessary for the Framework to work well (css, javascripts, ...). This Method must be overridden by a concrete Painter Class.

Specified by:

doCreateHeaderIncludes in class PainterFactory

Parameters:

writer - The JspWriter

Throws:

java.io.IOException - If an input or output exception occurred

See Also:

PainterFactory.doCreateHeaderIncludes(javax.servlet.jsp.JspWriter)