info.magnolia.templating.elements
Class EditElement

java.lang.Object
  info.magnolia.templating.elements.AbstractTemplatingElement
      info.magnolia.templating.elements.AbstractContentTemplatingElement
          info.magnolia.templating.elements.EditElement

All Implemented Interfaces:

TemplatingElement

public class EditElement
extends AbstractContentTemplatingElement

Embeds a marker within the page that instructs the page editor to place an edit bar/button at this location.

Version:

$Id$

Field Summary

static String	CMS_EDIT
static String	DEFAULT_FORMAT
static String	FORMAT_BAR
static String	FORMAT_BUTTON

Constructor Summary

EditElement(info.magnolia.cms.beans.config.ServerConfiguration server, info.magnolia.rendering.context.RenderingContext renderingContext)

Method Summary

void	begin(Appendable out)
void	end(Appendable out) Override this method if you need to "do something" once the component is rendered, i.e cleanup the context.
String	getDialog()
String	getFormat()
void	setDialog(String dialog)
void	setFormat(String format)

Methods inherited from class info.magnolia.templating.elements.AbstractContentTemplatingElement

getContent, getNodeIdentifier, getNodePath, getPath, getTargetContent, getWorkspace, restoreAttributesInWebContext, setAttributesInWebContext, setContent, setNodeIdentifier, setPath, setWorkspace

Methods inherited from class info.magnolia.templating.elements.AbstractTemplatingElement

currentContent, getDefinitionMessage, getInterfaceMessage, getRenderingContext, getServer, isAdmin

Methods inherited from class java.lang.Object

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

Field Detail

CMS_EDIT

public static final String CMS_EDIT

See Also:

Constant Field Values

FORMAT_BAR

public static final String FORMAT_BAR

See Also:

Constant Field Values

FORMAT_BUTTON

public static final String FORMAT_BUTTON

See Also:

Constant Field Values

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

See Also:

Constant Field Values

Constructor Detail

EditElement

public EditElement(info.magnolia.cms.beans.config.ServerConfiguration server,
                   info.magnolia.rendering.context.RenderingContext renderingContext)

Method Detail

begin

public void begin(Appendable out)
           throws IOException,
                  info.magnolia.rendering.engine.RenderException

Specified by:

begin in interface TemplatingElement

Overrides:

begin in class AbstractTemplatingElement

Throws:

IOException

info.magnolia.rendering.engine.RenderException

end

public void end(Appendable out)
         throws IOException,
                info.magnolia.rendering.engine.RenderException

Description copied from class: AbstractTemplatingElement

Override this method if you need to "do something" once the component is rendered, i.e cleanup the context.

Specified by:

end in interface TemplatingElement

Overrides:

end in class AbstractTemplatingElement

Throws:

IOException

info.magnolia.rendering.engine.RenderException

getDialog

public String getDialog()

setDialog

public void setDialog(String dialog)

getFormat

public String getFormat()

setFormat

public void setFormat(String format)