|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthelma.doc.DocElement
public abstract class DocElement
Field Summary | |
---|---|
static int |
ACTION
|
static int |
APPLICATION
|
static int |
FUNCTION
|
static int |
MACRO
|
static int |
PROPERTIES
|
static int |
PROTOTYPE
|
static int |
SKIN
|
static int |
TEMPLATE
|
static java.lang.String[] |
typeNames
|
Constructor Summary | |
---|---|
protected |
DocElement(java.lang.String name,
int type)
|
Method Summary | |
---|---|
void |
addChild(DocElement child)
|
protected void |
addParameter(java.lang.String param)
add a string to the parameters-list |
void |
addTag(java.lang.String rawContent)
|
int |
countChildren()
|
static void |
debug(java.lang.String msg)
|
DocElement |
getChildElement(java.lang.String name)
from helma.framework.IPathElement. |
java.util.Map |
getChildren()
|
java.lang.String |
getComment()
returns the comment string, empty string if no comment is set. |
java.lang.String |
getContent()
the actual content of the doc element (the function body, the properties list, the file list etc. |
DocApplication |
getDocApplication()
walks up the tree and tries to find a DocApplication object |
java.lang.String |
getElementName()
from helma.framework.IPathElement. |
java.lang.String |
getName()
the simple name of the element |
java.lang.Object |
getParentElement()
from helma.framework.IPathElement. |
java.lang.String |
getPrototype()
from helma.framework.IPathElement. |
int |
getType()
|
java.lang.String |
getTypeName()
|
boolean |
hasParameter(java.lang.String param)
|
DocElement[] |
listChildren()
returns an array of doc elements, sorted by their name |
java.lang.String[] |
listParameters()
the list of parameters |
DocTag[] |
listTags()
list all tags |
DocTag[] |
listTags(java.lang.String type)
filter the tags according to their type |
void |
setParent(DocElement parent)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int APPLICATION
public static final int PROTOTYPE
public static final int ACTION
public static final int TEMPLATE
public static final int FUNCTION
public static final int MACRO
public static final int SKIN
public static final int PROPERTIES
public static final java.lang.String[] typeNames
Constructor Detail |
---|
protected DocElement(java.lang.String name, int type)
Method Detail |
---|
public java.lang.String getName()
public int getType()
public java.lang.String getTypeName()
public java.lang.String getComment()
public java.lang.String getContent()
public void addTag(java.lang.String rawContent)
rawContent
- ...public DocTag[] listTags()
public DocTag[] listTags(java.lang.String type)
public boolean hasParameter(java.lang.String param)
param
- ...
public java.lang.String[] listParameters()
protected void addParameter(java.lang.String param)
public void setParent(DocElement parent)
parent
- ...public void addChild(DocElement child)
child
- ...public int countChildren()
public java.util.Map getChildren()
public DocElement[] listChildren()
public DocApplication getDocApplication()
public java.lang.String getElementName()
public DocElement getChildElement(java.lang.String name)
public java.lang.Object getParentElement()
public java.lang.String getPrototype()
public java.lang.String toString()
toString
in class java.lang.Object
public static void debug(java.lang.String msg)
msg
- ...
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |