net.sf.basedb.clients.web.taglib.menu
Class Submenu

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      net.sf.basedb.clients.web.taglib.menu.Submenu

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class Submenu
extends TagSupport

This tag defines a menu item inside a drop-down menu. This tag can only be used inside a Menu tag, which should contain at least one of these tags.

Syntax:

   <m:submenu
      id=....
      style=...
      title=...
      subid=...
      tooltip=...
      enabled=...
      visible=...
      icon=...
   >

Attribute	Default value	Required	Description
id	-	no	The ID of the menuitem. The value of this attribute goes directly into the standard HTML id attribute. This means that if you need a reference to the menuitem object in your own JavaScript code, you may for example use the following code: menuitem = document.getElementById('<id>');
style	-	no	The value if this attribute goes directly into the standard HTML style attribute. This allows you to apply different styles to different menu items.
title	-	yes	The text that should be displayed in the menu for this menuitem.
subid	-	yes	The ID attribute of another menu that will be shown as a submenu.
tooltip	-	no	An optional tooltip that is shown as a popup text while the user is pointing the mouse over the menuitem. Not supported by all browsers.
enabled	1	no	0 to display a disabled (greyed-out) menu. All other values will enable the menu
visible	true	no	Use false to hide this menu item entirely.
icon	-	no	The filename of an icon to display before the title. The icon must be placed in the /images directory. Do not include any path information in the icon attribute.

Version:

2.0

Author:

Nicklas

See Also:

Serialized Form

Field Summary

private boolean	enabled If the menu item is enabled.
private String	icon An icon to display.
private boolean	iconAbsolute
private Menu	menu The parent Menu.
private static long	serialVersionUID
private String	style Optional style attribute
private String	subId The ID of the submenu.
private String	title The title of the menu item.
private String	tooltip A tooltip explaining the menu item.
private boolean	visible If the menu item is visible.

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

Submenu()

Method Summary

int	doStartTag()
String	getIcon()
String	getStyle()
String	getSubid()
String	getTitle()
String	getTooltip()
boolean	isEnabled()
boolean	isIconabsolute()
boolean	isVisible()
void	setEnabled(boolean enabled)
void	setIcon(String icon)
void	setIconabsolute(boolean absolute)
void	setStyle(String style)
void	setSubid(String subId)
void	setTitle(String title)
void	setTooltip(String tooltip)
void	setVisible(boolean visible)

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

doAfterBody, doEndTag, 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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

menu

private Menu menu

The parent Menu.

style

private String style

Optional style attribute

title

private String title

The title of the menu item.

subId

private String subId

The ID of the submenu.

tooltip

private String tooltip

A tooltip explaining the menu item.

enabled

private boolean enabled

If the menu item is enabled.

visible

private boolean visible

If the menu item is visible.

icon

private String icon

An icon to display.

iconAbsolute

private boolean iconAbsolute

Constructor Detail

Submenu

public Submenu()

Method Detail

setStyle

public void setStyle(String style)

getStyle

public String getStyle()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setSubid

public void setSubid(String subId)

getSubid

public String getSubid()

setTooltip

public void setTooltip(String tooltip)

getTooltip

public String getTooltip()

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

setIcon

public void setIcon(String icon)

getIcon

public String getIcon()

setIconabsolute

public void setIconabsolute(boolean absolute)

isIconabsolute

public boolean isIconabsolute()

doStartTag

public int doStartTag()
               throws JspException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Throws:

JspException