WEB4J Development Tools 4.10.0.0

hirondelle.web4jtools.taglet
Class ViewTaglet

Object
  extended by hirondelle.web4jtools.taglet.ViewTaglet
All Implemented Interfaces:
Taglet

public final class ViewTaglet
extends Object
implements Taglet

Taglet for linking to .jsp files.

The .jsp files need to be copied into the javadoc tree. The typical use case is to place the .jsp file in the same directory as the class that references it.

Example use case :
&view view.jsp


Constructor Summary
ViewTaglet()
           
 
Method Summary
 String getName()
          Return 'view'.
 boolean inConstructor()
          Return false.
 boolean inField()
          Return false.
 boolean inMethod()
          Return false.
 boolean inOverview()
          Return false.
 boolean inPackage()
          Return false.
 boolean inType()
          Return true.
 boolean isInlineTag()
          Return false.
static void register(Map aTagletMap)
          Register this taglet with the javadoc tool, under the taglet name 'view'.
 String toString(Tag aTag)
          Render a single &view item.
 String toString(Tag[] aTags)
          Render a series of &view items.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewTaglet

public ViewTaglet()
Method Detail

register

public static void register(Map aTagletMap)
Register this taglet with the javadoc tool, under the taglet name 'view'.


getName

public String getName()
Return 'view'.

Specified by:
getName in interface Taglet

isInlineTag

public boolean isInlineTag()
Return false.

Specified by:
isInlineTag in interface Taglet

inOverview

public boolean inOverview()
Return false.

Specified by:
inOverview in interface Taglet

inPackage

public boolean inPackage()
Return false.

Specified by:
inPackage in interface Taglet

inType

public boolean inType()
Return true.

Specified by:
inType in interface Taglet

inConstructor

public boolean inConstructor()
Return false.

Specified by:
inConstructor in interface Taglet

inMethod

public boolean inMethod()
Return false.

Specified by:
inMethod in interface Taglet

inField

public boolean inField()
Return false.

Specified by:
inField in interface Taglet

toString

public String toString(Tag[] aTags)
Render a series of &view items.

Specified by:
toString in interface Taglet

toString

public String toString(Tag aTag)
Render a single &view item.

Specified by:
toString in interface Taglet

WEB4J Development Tools 4.10.0.0

Copyright Hirondelle Systems - Generated 2013Oct19.12.26