|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TagDefinition
Expose the definition of a tag, as declared in a 'org.eclipse.jet.tagLibraries' extension.
This interface is not intended to be implemented by clients.
Method Summary | |
---|---|
TagAttributeDefinition |
getAttributeDefinition(java.lang.String name)
Return the definition of the named attribute |
java.util.List |
getAttributeDefinitions()
Return a list of attribute definitions for this tag |
java.lang.String |
getDescription()
|
CustomTagKind |
getKind()
Return the tag kind ( CustomTagKind ). |
java.lang.String |
getName()
Return the name of the tag as it is registered in the tag library |
TagLibrary |
getTagLibrary()
Return the TagLibrary that contains this tag definition. |
boolean |
isContentAllowed()
Test whether the tag is allowed to have content (even empty content). |
boolean |
isDeprecated()
Test if the tag is declared to be deprecated. |
boolean |
isEmptyTagAllowed()
Test whether the tag is allowed to be specified in the empty tag form: <tagName/>. |
boolean |
removeWhenContainingLineIsEmpty()
Indicate whether the compiler should remove whitespace including the trailing new line from tags that occur on an otherwise empty line. |
boolean |
requiresNewWriter()
Test whether the tag requires a new writer for its contents. |
Method Detail |
---|
java.lang.String getName()
java.lang.String getDescription()
CustomTagKind getKind()
CustomTagKind
).
TagAttributeDefinition getAttributeDefinition(java.lang.String name)
name
- the attribute name
null
if the name
is not
an attribute of the named tag.java.util.List getAttributeDefinitions()
TagAttributeDefinition
objects. The empty list is returned if there
are no attribute definitions for this tag definition.boolean isDeprecated()
true
if the tag is deprecated.boolean requiresNewWriter()
true
:
functionTag
containerTag
with processContents
set to custom
.conditionalTag
with processContents
set to custom
.iteratingTag
with processContents
set to custom
.
true
if a new writer is required, false
otherwise.boolean isEmptyTagAllowed()
true
.
emptyTag
containerTag
with allowAsEmpty
set to true
.
true
if the tag may be expressed as a empty tag.boolean isContentAllowed()
<tagName> ... </tagName>The following tag declarations will have the value set to
true
:
functionTag
containerTag
conditionalTag
iteratingTag
true
if the tag may be expressed as a content tag.TagLibrary getTagLibrary()
TagLibrary
that contains this tag definition.
boolean removeWhenContainingLineIsEmpty()
true
if such whitespace should be removed.
|
Copyright 2006 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |