Package org.mmbase.framework

The package contains the component framework of MMBase.

See:
Description

Interface Summary

Component	A component is a piece of pluggable functionality that typically has dependencies on other components.
Processor	A Processor handles interaction of a Block.
Renderer	A Renderer renders a certain aspect of a Block.

Class Summary

AbstractProcessor	Abstract view implementation which implements getType and the specific parameters.
AbstractRenderer	Abstract renderer implementation which implements getType and getBlock.
BasicComponent	A component is a piece of pluggable functionality that typically has dependencies on other components, and may be requested several blocks.
Block	A Block is a representation of a page within a component.
Block.BlockContainer	A wrapper class for a certain block in a type, which defined its weighted place in between it's child block of the same type.
Block.Type	Every block can be assigned a hierarchal 'Type', which can classify it.
CachedRenderer	This renderer caches other renderers.
ChainedRenderer	This renderer simply calls the methods of a number of other Renderers sequentially.
ComponentRepository	This (singleton) class maintains all Components which are registered in the current MMBase.
ComponentRepository.Ready
ConnectionRenderer	A Renderer implementation based on an external connection.
DeniedRenderer	Renderer to be used in case of access denied (status 401).
DocumentationRenderer	Currently renders documentation directly from subversion, using an XSLT to convert docbook to HTML.
EditwizardRenderer	Generates an iframe with a wizard list (if the 'list' property is set) or a wizard wizard (if the 'wizard' property is set).
ErrorRenderer	If rendering of a Block fails for some reason this renderer should be used to present the error.
ErrorRenderer.Error
Framework	The MMBase Framework displays and processes components.
FrameworkFilter	Requestfilter that filters out all URL's looking for virtual 'userfriendly' links that have a corresponding page (technical URL) within the website.
Functions	Framework functions for use in XSLT.
IFrameRenderer	The IFrameRenderer renders a page (in the current web-app) in an iframe.
JspProcessor	A Processor implementation based on a jsp in the /mmbase/components/ directory.
JspRenderer	A Renderer implementation based on a jsp in the /mmbase/components/ directory.
RenderHints	A Renderer is used by Renderer.render(org.mmbase.util.functions.Parameters, java.io.Writer, org.mmbase.framework.RenderHints), with a RenderHints object, which gives to Renderer implementation some instructions about how to render excactly, since it may vary a bit in that.
ResourceRenderer	A Renderer implementation based on an MMBase's ResourceLoader.
Setting<C>	Representation of Component related settings.
Setting.DataType
StringRenderer	The overly simple renderer which is simply based on a String present in the configuration file.
Utils	Static utilitiy methods which are related to (combine functionality of) other classes in the packages.
VirtualComponent	A Virtual Component is a component which is only mentioned as a dependency of another Component.
WrappedRenderer	A generic implementation of a Renderer that wraps another Renderer.

Enum Summary

Renderer.Type
RenderHints.Mode
WindowState	Every block can be in a certain window state, which could be considered during rendering.

Exception Summary

FrameworkException

This exception gets thrown when something goes wrong in the Framework, such as when rendering or processing a component.

Package org.mmbase.framework Description

The package contains the component framework of MMBase.

Key classes in this package are:

• Framework
• State. The render state. The framework is responsible for calling State.getState(request). See BasicFramework.
• The ComponentRepository. There is one instance of this in every MMBase, and all Components, can be found in here.
• UrlConverter. The framework is also responsible for producingURL's. This can be implemented seperately (BasicFramework maintains a list of external UrlConverters to implement it's own url-conversion functionalilty)

Since:

MMBase-1.9