info.magnolia.cms.taglibs
Class EditBar

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by info.magnolia.cms.taglibs.EditBar
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class EditBar
extends javax.servlet.jsp.tagext.TagSupport

Displays Magnolia editBar which allows you to edit a paragraph. This tag is often used within contentNodeIterator, which in turn will set all relevant parameters automatically.

Version:
$Revision: 41137 $ ($Author: gjoseph $)
Author:
Sameer Charles, Marcel Salathe
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
EditBar()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 boolean isShowParagraphName()
           
protected  void reset()
           
 void setAdminOnly(boolean adminOnly)
          Show only in admin instance, default to true.
 void setContentNodeCollectionName(String name)
          The contentNode collection.
 void setContentNodeName(String name)
          The contentNode (i.e.
 void setDeleteLabel(String label)
          The text of the delete button, defaults to "Delete".
 void setDialog(String dialog)
          Name of the dialog to open.
 void setEditLabel(String label)
          The text of the edit button, defaults to "Edit".
 void setMoveLabel(String label)
          The text of the move button, defaults to "Move".
 void setParagraph(String paragraph)
          Name of paragraph (as defined in config).
 void setShowParagraphName(boolean showParagraphName)
          Show the paragraph name, default to false.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EditBar

public EditBar()
Method Detail

setContentNodeName

public void setContentNodeName(String name)
The contentNode (i.e. paragraph) you wish to edit.


setContentNodeCollectionName

public void setContentNodeCollectionName(String name)
The contentNode collection.


setParagraph

public void setParagraph(String paragraph)
Name of paragraph (as defined in config). Does not have to be set inside "contentNodeIterator".


setDialog

public void setDialog(String dialog)
Name of the dialog to open. If specified, overrides the paragraph attribute, or the dialog name determined by the current paragraph if any.


setEditLabel

public void setEditLabel(String label)
The text of the edit button, defaults to "Edit".


setDeleteLabel

public void setDeleteLabel(String label)
The text of the delete button, defaults to "Delete". Use "" to get no delete button.


setMoveLabel

public void setMoveLabel(String label)
The text of the move button, defaults to "Move". Use "" to get no move button.


setAdminOnly

public void setAdminOnly(boolean adminOnly)
Show only in admin instance, default to true.

Parameters:
adminOnly - The adminOnly to set.

isShowParagraphName

public boolean isShowParagraphName()

setShowParagraphName

public void setShowParagraphName(boolean showParagraphName)
Show the paragraph name, default to false.

Parameters:
showParagraphName - Show the paragraph name.

doStartTag

public int doStartTag()
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
See Also:
Tag.doStartTag()

doEndTag

public int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
See Also:
Tag.doEndTag()

reset

protected void reset()


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