ilog.views.faces.taglib
Class IlvFacesMenuItemTag

java.lang.Object
  ilog.views.faces.taglib.IlvFacesMenuItemTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

IlvFacesMenuSeparatorTag, IlvFacesMenuTag

public class IlvFacesMenuItemTag
extends Object
implements javax.servlet.jsp.tagext.Tag

This JSP custom tag handler manages a menu item tag instance.

This tag parent must be an IlvFacesMenuTag instance.

Since:

JViews 7.5

Field Summary

protected javax.servlet.jsp.PageContext

pageContext The JSP PageContext for the page we are embedded in.

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

IlvFacesMenuItemTag()
Creates a new IlvFacesMenuItemTag instance.

Method Summary

protected void	connectToParent() Connects the item created by this tag to the parent tag's item.
IlvMenuItem	createMenuItem(String label) Returns a new IlvMenuItem instance.
int	doEndTag() Process the end tag for this instance.
int	doStartTag() Process the start tag for this instance.
String	getActionListener() Returns the actionListener tag attribute value.
protected int	getDoStartReturnCode() Returns the return code of the doStart() method.
String	getEnabled() Returns the enabled tag attribute value.
String	getId() Returns the id tag attribute value.
String	getImage() Returns the image tag attribute value.
String	getInvocationContext() Returns the actionListener tag attribute value.
IlvMenuItem	getItem() Returns the IlvMenuItem instance created by this tag.
String	getLabel() Returns the actionListener tag attribute value.
String	getOnclick() Returns the onclick tag attribute value.
javax.servlet.jsp.PageContext	getPageContext() Returns the PageContext of the page containing this tag instance.
javax.servlet.jsp.tagext.Tag	getParent() Return the Tag that is the parent of this instance.
protected void	handleActionListener() Handles menu item action.
void	release() Called on a Tag handler to release state.
void	setActionListener(String actionListener) Sets the actionListener tag attribute value.
void	setEnabled(String enabled) Sets the enabled tag attribute value.
void	setId(String id) Sets the actionListener tag attribute value.
void	setImage(String image) Sets the image tag attribute value.
void	setInvocationContext(String invocationContext) Sets the actionListener tag attribute value.
void	setLabel(String label) Sets the actionListener tag attribute value.
void	setOnclick(String onclick) Sets the onclick tag attribute value.
void	setPageContext(javax.servlet.jsp.PageContext pageContext) Set the PageContext of the page containing this tag instance.
void	setParent(javax.servlet.jsp.tagext.Tag parent) Set the Tag that is the parent of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

pageContext

protected javax.servlet.jsp.PageContext pageContext

The JSP PageContext for the page we are embedded in.

Constructor Detail

IlvFacesMenuItemTag

public IlvFacesMenuItemTag()

Creates a new IlvFacesMenuItemTag instance.

Method Detail

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pageContext)

Set the PageContext of the page containing this tag instance.

Specified by:

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

Parameters:

pageContext - The enclosing PageContext

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

Returns the PageContext of the page containing this tag instance.

Returns:

The enclosing PageContext.

getParent

public javax.servlet.jsp.tagext.Tag getParent()

Return the Tag that is the parent of this instance.

Specified by:

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

setParent

public void setParent(javax.servlet.jsp.tagext.Tag parent)

Set the Tag that is the parent of this instance.

Specified by:

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

Parameters:

parent - The new parent Tag

doStartTag

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

Process the start tag for this instance. This method is invoked by the JSP page implementation object.

Specified by:

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

Returns:

getDoStartReturnCode() value.

Throws:

javax.servlet.jsp.JspException

handleActionListener

protected void handleActionListener()

Handles menu item action.
This method processes the onlick and the actionListener tag attributes.

getDoStartReturnCode

protected int getDoStartReturnCode()

Returns the return code of the doStart() method.

This implementation returns SKIP_BODY.

Returns:

The doStart return code.

connectToParent

protected void connectToParent()

Connects the item created by this tag to the parent tag's item.

doEndTag

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

Process the end tag for this instance. This method is invoked by the JSP page implementation object on all Tag handlers.

Specified by:

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

Returns:

EVAL_PAGE.

Throws:

javax.servlet.jsp.JspException

release

public void release()

Called on a Tag handler to release state.

Specified by:

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

getActionListener

public String getActionListener()

Returns the actionListener tag attribute value.

Returns:

The action listener tag attribute value.

setActionListener

public void setActionListener(String actionListener)

Sets the actionListener tag attribute value.

Parameters:

actionListener - The action listener tag attribute value.

getImage

public String getImage()

Returns the image tag attribute value.

Returns:

The image tag attribute value.

setImage

public void setImage(String image)

Sets the image tag attribute value.

Parameters:

image - The action listener tag attribute value.

getItem

public IlvMenuItem getItem()

Returns the IlvMenuItem instance created by this tag.

Returns:

The menu item built by this tag.

createMenuItem

public IlvMenuItem createMenuItem(String label)

Returns a new IlvMenuItem instance.

Parameters:

label - The label of the menu item.

Returns:

A new menu item instance.

getLabel

public String getLabel()

Returns the actionListener tag attribute value.

Returns:

The action listener tag attribute value.

setLabel

public void setLabel(String label)

Sets the actionListener tag attribute value.

Parameters:

label - The label tag attribute value.

getInvocationContext

public String getInvocationContext()

Returns the actionListener tag attribute value.

Returns:

The invocation context tag attribute value.

setInvocationContext

public void setInvocationContext(String invocationContext)

Sets the actionListener tag attribute value.

Parameters:

invocationContext - The invocation context tag attribute value.

getOnclick

public String getOnclick()

Returns the onclick tag attribute value.

Returns:

The onclick tag attribute value.

setOnclick

public void setOnclick(String onclick)

Sets the onclick tag attribute value.

Parameters:

onclick - The onclick tag attribute value.

getEnabled

public String getEnabled()

Returns the enabled tag attribute value.

Returns:

The enabled tag attribute value.

setEnabled

public void setEnabled(String enabled)

Sets the enabled tag attribute value.

Parameters:

enabled - The enabled tag attribute value.

getId

public String getId()

Returns the id tag attribute value.

Returns:

The id tag attribute value.

setId

public void setId(String id)

Sets the actionListener tag attribute value.

Parameters:

id - The id tag attribute value.