org.apache.openejb.jee
Class TagFile

java.lang.Object
  extended by org.apache.openejb.jee.TagFile

public class TagFile
extends java.lang.Object

Defines an action in this tag library that is implemented as a .tag file.

The tag-file element has two required subelements:

description Optional tag-specific information

display-name A short name that is intended to be displayed by tools

icon Optional icon element that can be used by tools

name The unique action name

path Where to find the .tag file implementing this action, relative to the root of the web application or the root of the JAR file for a tag library packaged in a JAR. This must begin with /WEB-INF/tags if the .tag file resides in the WAR, or /META-INF/tags if the .tag file resides in a JAR.

example Optional informal description of an example of a use of this tag

tag-extension Zero or more extensions that provide extra information about this tag, for tool consumption


Field Summary
protected  TextMap description
           
protected  TextMap displayName
           
protected  java.lang.String example
           
protected  LocalCollection<Icon> icon
           
protected  java.lang.String id
           
protected  java.lang.String name
           
protected  java.lang.String path
           
protected  java.util.List<TldExtension> tagExtension
           
 
Constructor Summary
TagFile()
           
 
Method Summary
 java.lang.String getDescription()
           
 Text[] getDescriptions()
           
 java.lang.String getDisplayName()
           
 Text[] getDisplayNames()
           
 java.lang.String getExample()
           
 Icon getIcon()
           
 java.util.Map<java.lang.String,Icon> getIconMap()
           
 java.util.Collection<Icon> getIcons()
           
 java.lang.String getId()
           
 java.lang.String getName()
           
 java.lang.String getPath()
           
 java.util.List<TldExtension> getTagExtension()
           
 void setDescriptions(Text[] text)
           
 void setDisplayNames(Text[] text)
           
 void setExample(java.lang.String value)
           
 void setId(java.lang.String value)
           
 void setName(java.lang.String value)
           
 void setPath(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected TextMap description

displayName

protected TextMap displayName

icon

protected LocalCollection<Icon> icon

name

protected java.lang.String name

path

protected java.lang.String path

example

protected java.lang.String example

tagExtension

protected java.util.List<TldExtension> tagExtension

id

protected java.lang.String id
Constructor Detail

TagFile

public TagFile()
Method Detail

getDescriptions

public Text[] getDescriptions()

setDescriptions

public void setDescriptions(Text[] text)

getDescription

public java.lang.String getDescription()

getDisplayNames

public Text[] getDisplayNames()

setDisplayNames

public void setDisplayNames(Text[] text)

getDisplayName

public java.lang.String getDisplayName()

getIcons

public java.util.Collection<Icon> getIcons()

getIconMap

public java.util.Map<java.lang.String,Icon> getIconMap()

getIcon

public Icon getIcon()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String value)

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String value)

getExample

public java.lang.String getExample()

setExample

public void setExample(java.lang.String value)

getTagExtension

public java.util.List<TldExtension> getTagExtension()

getId

public java.lang.String getId()

setId

public void setId(java.lang.String value)


Copyright © 1999-2011 The Apache OpenEJB development community. All Rights Reserved.