info.magnolia.module.templating
Class Paragraph

java.lang.Object
  extended by info.magnolia.module.templating.AbstractRenderable
      extended by info.magnolia.module.templating.Paragraph
All Implemented Interfaces:
RenderableDefinition
Direct Known Subclasses:
Paragraph

public class Paragraph
extends AbstractRenderable

Represents a paragraph definition. Following are most of the properties you can use to configure your paragraphs. Of course, if you're using specific subclasses, other properties could be available.

Property Default Values Description
class Paragraph    
type jsp jsp,freemarker,… Determines which ParagraphRenderer to use. Out of the box, Magnolia provides support for JSP and FreeMarker.
templatePath   This property follows conventional syntax for path definitions. This property defines the path to the template to be used for this paragraph.
modelClass   The fully qualified name of a class implementing RenderingModel The bean created by the renderer based on the modelClass defined on the paragraph or template definition. The current content, definition and the parent model are passed to the constructor. This object is instantiated for each rendering of a template or a paragraph.
i18nBasename info.magnolia.module. admininterface.messages or whatever the i18nBasename is set to in the dialog for this paragraph. This can be any properly defined Magnolia message bundle. This property defines the message bundle to use for this paragraph.
title   The title or a message bundle key to be used with the bundle defined by i18nBasename. This property defines the title of the paragraph.
description   The description or a message bundle key to be used with the bundle defined by i18nBasename. This property is used to describe the paragraph.
dialog     This property is used to specify the name of the dialog associated with this paragraph.

Author:
Sameer Charles

Constructor Summary
Paragraph()
           
 
Method Summary
 String getDialogPath(String path)
          Deprecated. since 4.0 use the dialog property
 String getTemplateType()
          Deprecated. since 4.0 use the type property
 void setDialogPath(String path)
          Deprecated. since 4.0 use the dialog property
 void setTemplateType(String type)
          Deprecated. since 4.0 use the type property
 
Methods inherited from class info.magnolia.module.templating.AbstractRenderable
determineTemplatePath, getDescription, getDialog, getI18nBasename, getModelClass, getName, getParameters, getTemplatePath, getTitle, getType, newModel, setDescription, setDialog, setI18nBasename, setModelClass, setName, setParameters, setTemplatePath, setTitle, setType, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Paragraph

public Paragraph()
Method Detail

getTemplateType

public String getTemplateType()
Deprecated. since 4.0 use the type property


setTemplateType

public void setTemplateType(String type)
Deprecated. since 4.0 use the type property


getDialogPath

public String getDialogPath(String path)
Deprecated. since 4.0 use the dialog property


setDialogPath

public void setDialogPath(String path)
Deprecated. since 4.0 use the dialog property



Copyright © 2003-2010 Magnolia International Ltd.. All Rights Reserved.