com.escenic.menu.taglib

Class MenuIteratorTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

neo.taglib.base.IoTagSupport

neo.taglib.base.IoBodyTagSupport

com.escenic.menu.taglib.MenuIteratorTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class MenuIteratorTag
extends neo.taglib.base.IoBodyTagSupport

A tag which iterates a menu

See Also:

Serialized Form

Field Summary

Fields inherited from class neo.taglib.base.IoBodyTagSupport

bodyContent

Fields inherited from class neo.taglib.base.IoTagSupport

APPLICATION_SCOPE, BROWSER, COM_ESCENIC_STALE, DEFAULT_STRINGBUFFER_SIZE, EMPTY_STRING, LARGE_STRINGBUFFER_SIZE, LOGGER, PAGE_SCOPE, PUBLISHED, REQUEST_SCOPE, SESSION_SCOPE

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

Constructors

Constructor and Description
MenuIteratorTag() constructor

Method Summary

Modifier and Type	Method and Description
protected void	addDefault(ArrayList list, MenuItem root)
int	doAfterBody()
int	doEndTag()
int	doStartTag()
MenuItem	getCurrent() Returns the Current attribute of the MenuIteratorTag object
int	getCurrentSectionID() returns current sectionid
String	getDepth()
String	getStartID()
int	getStartIdInt()
boolean	isCurrentInPath() checks if current iterator element is a in path of current section
boolean	isCurrentInPath(MenuItem pCurrentIteratorElement) checks if current iterator element is a in path of current section
boolean	isCurrentNormal() checks if current iterator element is not a sibling of current section
boolean	isCurrentOpen() Check to see if this item is open, that is it's parent is in path...
boolean	isCurrentSibling() checks if current iterator element is a sibling of current section
boolean	isIteratorCurrent() checks if current iterator element is current section current section
boolean	isSubOfCurrent()
protected void	iterateMenu(ArrayList list, Menu menu)
protected int	next()
void	release()
void	setCurrentSectionID(int _currentSectionID) sets current section id
void	setDepth(String level)
void	setMenu(Menu b) Sets the Menu attribute of the MenuIteratorTag object
void	setStartID(String newStartID)

Methods inherited from class neo.taglib.base.IoBodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class neo.taglib.base.IoTagSupport

allowStale, convertToScope, getAPI, getJspPath, getName, getObjectByProperty, getProperty, getServletContext, getSpecifiedObject, getSpecifiedObject, getSpecifiedObject, getToScope, isLoggingEnabled, setName, setProperty, setToScope

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

MenuIteratorTag

public MenuIteratorTag()

constructor

Method Detail

setMenu

public void setMenu(Menu b)

Sets the Menu attribute of the MenuIteratorTag object

Parameters:

b - the new Menu value

getCurrent

public MenuItem getCurrent()

Returns the Current attribute of the MenuIteratorTag object

Returns:

the Current value

iterateMenu

protected void iterateMenu(ArrayList list,
                           Menu menu)

addDefault

protected void addDefault(ArrayList list,
                          MenuItem root)

doStartTag

public int doStartTag()

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class neo.taglib.base.IoBodyTagSupport

doAfterBody

public int doAfterBody()

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class neo.taglib.base.IoBodyTagSupport

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class neo.taglib.base.IoBodyTagSupport

isCurrentSibling

public boolean isCurrentSibling()

checks if current iterator element is a sibling of current section

isCurrentNormal

public boolean isCurrentNormal()

checks if current iterator element is not a sibling of current section

isCurrentInPath

public boolean isCurrentInPath(MenuItem pCurrentIteratorElement)

checks if current iterator element is a in path of current section

isCurrentInPath

public boolean isCurrentInPath()

checks if current iterator element is a in path of current section

isSubOfCurrent

public boolean isSubOfCurrent()

isIteratorCurrent

public boolean isIteratorCurrent()

checks if current iterator element is current section current section

isCurrentOpen

public boolean isCurrentOpen()

Check to see if this item is open, that is it's parent is in path...

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class neo.taglib.base.IoBodyTagSupport

Throws:

javax.servlet.jsp.JspException

next

protected int next()

getCurrentSectionID

public int getCurrentSectionID()

returns current sectionid

setCurrentSectionID

public void setCurrentSectionID(int _currentSectionID)

sets current section id

setDepth

public void setDepth(String level)

getDepth

public String getDepth()

setStartID

public void setStartID(String newStartID)

getStartID

public String getStartID()

getStartIdInt

public int getStartIdInt()