org.enhydra.barracuda.contrib.dbroggisch.page
Class AbstractPage

java.lang.Object
  extended byorg.enhydra.barracuda.core.event.DefaultBaseEventListener
      extended byorg.enhydra.barracuda.core.event.helper.DefaultViewHandler
          extended byorg.enhydra.barracuda.contrib.dbroggisch.page.AbstractPage
All Implemented Interfaces:
BaseEventListener, EventListener, Page

public abstract class AbstractPage
extends DefaultViewHandler
implements Page

Version:
1.0
Author:
Diez B. Roggisch

Field Summary
 
Fields inherited from class org.enhydra.barracuda.core.event.helper.DefaultViewHandler
localLogger, recycleChildren, vc
 
Fields inherited from class org.enhydra.barracuda.core.event.DefaultBaseEventListener
idStr
 
Constructor Summary
AbstractPage()
           
 
Method Summary
 void createDefaultModels(ControlEventContext ctx)
          Describe createDefaultModels method here.
static void filterEvents(ControlEventContext ctx, List defaultEvents)
          Describe filterEvents method here.
abstract  Document getDocument(Locale iLocale)
          Return a Document instance.
 Document handleViewEvent(BComponent root)
          Describe handleViewEvent method here.
abstract  void render(BComponent root, ViewContext vec, Document doc)
          Overload this method to perform the actual process of rendering.
 void render(ViewEventContext vec)
          Describe render method here.
 void setDefaultEvents(List events)
          Describe setDefaultEvents method here.
 
Methods inherited from class org.enhydra.barracuda.core.event.helper.DefaultViewHandler
getDOMWriter, getViewContext, handleViewEvent, postCompRender, preCompRender, setViewContext
 
Methods inherited from class org.enhydra.barracuda.core.event.DefaultBaseEventListener
getListenerID, handleControlEvent, handleEvent, handleOtherEvent, isHandled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.enhydra.barracuda.contrib.dbroggisch.page.Page
handOver
 

Constructor Detail

AbstractPage

public AbstractPage()
Method Detail

setDefaultEvents

public void setDefaultEvents(List events)
Describe setDefaultEvents method here.

Parameters:
events - a List value

createDefaultModels

public void createDefaultModels(ControlEventContext ctx)
Describe createDefaultModels method here.

Specified by:
createDefaultModels in interface Page
Parameters:
ctx - a ControlEventContext value

getDocument

public abstract Document getDocument(Locale iLocale)
Return a Document instance. This is called once before the rendering takes place and should return a new instance.

Parameters:
iLocale - the Locale of the client for locale specific documents
Returns:
a Document value

handleViewEvent

public Document handleViewEvent(BComponent root)
                         throws EventException,
                                javax.servlet.ServletException,
                                IOException
Describe handleViewEvent method here.

Specified by:
handleViewEvent in class DefaultViewHandler
Parameters:
root - a BComponent value
Returns:
a Document value
Throws:
EventException - if an error occurs
javax.servlet.ServletException - if an error occurs
IOException - if an error occurs

render

public void render(ViewEventContext vec)
            throws EventException,
                   javax.servlet.ServletException,
                   IOException
Describe render method here.

Specified by:
render in interface Page
Parameters:
vec - a ViewEventContext value
Throws:
EventException - if an error occurs
javax.servlet.ServletException - if an error occurs
IOException - if an error occurs

render

public abstract void render(BComponent root,
                            ViewContext vec,
                            Document doc)
                     throws EventException,
                            javax.servlet.ServletException,
                            IOException
Overload this method to perform the actual process of rendering.

Parameters:
root - a BComponent value you have to add your BComponents to.
vec - a ViewContext value
doc - a Document value which is obtained by calling getDocument(Locale)
Throws:
EventException - if an error occurs
javax.servlet.ServletException - if an error occurs
IOException - if an error occurs

filterEvents

public static void filterEvents(ControlEventContext ctx,
                                List defaultEvents)
Describe filterEvents method here.

Parameters:
ctx - a ControlEventContext value
defaultEvents - a List value


Copyright © 2003 BarracudaMVC.org All Rights Reserved.