2.17.2: 2011-06-17

net.sf.basedb.clients.web.taglib.path
Class PathElement

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by net.sf.basedb.clients.web.taglib.path.PathElement
All Implemented Interfaces:
Serializable, IterationTag, JspTag, Tag

public class PathElement
extends TagSupport

This tag defines an element of a path. The element is the part that is visible to the user as a clickable link to some other page.

Syntax:

   <p:pathelement
      id=....
      style=...
      title=...
      href=...
      tooltip=...
      visible=true|false
      enabled=true|false
   >

Attribute Default value Required Description
id - no The ID of the path element. 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:

pathElement = 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.
href - no The URL that this item links to, or null if it shouldn't be linked.
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.
visible true no Set to false to hide the path element completely.
enabled true no Set to false to not link the path. This is an alternative to set the URL to null.

Version:
2.0
Author:
Nicklas
See Also:
Serialized Form
Last modified
$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Field Summary
private  String clazz
          Optional class attribute
private  boolean enabled
           
private  String href
          URL to the linked page.
private  Path path
          The parent Path.
private static long serialVersionUID
           
private  String style
          Optional style attribute
private  String title
          The title of the menu item.
private  String tooltip
          A tooltip explaining the link.
private  boolean 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
PathElement()
           
 
Method Summary
 int doStartTag()
           
 String getClazz()
           
 String getHref()
           
 String getStyle()
           
 String getTitle()
           
 String getTooltip()
           
 boolean isEnabled()
           
 boolean isVisible()
           
 void setClazz(String clazz)
           
 void setEnabled(boolean enabled)
           
 void setHref(String href)
           
 void setStyle(String style)
           
 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

path

private Path path
The parent Path.


clazz

private String clazz
Optional class attribute


style

private String style
Optional style attribute


title

private String title
The title of the menu item.


href

private String href
URL to the linked page.


tooltip

private String tooltip
A tooltip explaining the link.


visible

private boolean visible

enabled

private boolean enabled
Constructor Detail

PathElement

public PathElement()
Method Detail

setClazz

public void setClazz(String clazz)

getClazz

public String getClazz()

setStyle

public void setStyle(String style)

getStyle

public String getStyle()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setHref

public void setHref(String href)

getHref

public String getHref()

setTooltip

public void setTooltip(String tooltip)

getTooltip

public String getTooltip()

setVisible

public void setVisible(boolean visible)
Since:
2.10

isVisible

public boolean isVisible()
Since:
2.10

setEnabled

public void setEnabled(boolean enabled)
Since:
2.10

isEnabled

public boolean isEnabled()
Since:
2.10

doStartTag

public int doStartTag()
               throws JspException
Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class TagSupport
Throws:
JspException

2.17.2: 2011-06-17