|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.omnipilot.lassopro.LassoTagModule
Base class for any tag module.
Most tag modules output data onto the web page, though some tags may
perform other actions based on the parameters passed to them.
Every LassoTagModule
must implement registerLassoModule
method, and one or more methods with the same signature as TAG_METHOD_PROTOTYPE
.
Lasso calls registerLassoModule
once at startup to give this
module a chance to register its tags. LassoTagModule
must then
call registerTagModule
as many times as there are tags implemented by this module.
Field Summary | |
static int |
FLAG_ASYNC
The tag is to be run in its own thread. |
static int |
FLAG_CONTAINER
The tag is a container tag. |
static int |
FLAG_DEPRECATED
Use of the tag is deprecated. |
static int |
FLAG_INITIALIZER
The tag is to be treated as an initializer for a custom type. |
static int |
FLAG_LOOPING
The tag is a looping container tag. |
static int |
FLAG_NO_GLOBAL_IMPORT
The tag should not be automatically imported into the global namespace. |
static int |
FLAG_SKIP_SECURITY_CHECK
Bypass any security checks for the tag. |
static int |
FLAG_SUBSTITUTION
The tag is to be treated as a "regular" tag. |
static int |
FLAG_USER1
User-defined flag. |
static int |
FLAG_USER2
User-defined flag. |
static int |
FLAG_USER3
User-defined flag. |
static int |
FLAG_USER4
User-defined flag. |
Fields inherited from interface com.omnipilot.lassopro.LassoJavaModule |
ERR_NOERR |
Constructor Summary | |
protected |
LassoTagModule()
|
Method Summary | |
protected void |
registerTagModule(java.lang.String moduleName,
java.lang.String tagName,
java.lang.String methodName,
int flags,
java.lang.String description)
Use this method to register substitution tags implemented by your module. |
int |
TAG_METHOD_PROTOTYPE(LassoCall lasso,
int action)
A prototype for all tag methods registered by registerTagModule . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.omnipilot.lassopro.LassoJavaModule |
registerLassoModule |
Field Detail |
public static final int FLAG_INITIALIZER
public static final int FLAG_SUBSTITUTION
public static final int FLAG_ASYNC
public static final int FLAG_CONTAINER
tag; ... /tag;syntax or an error is generated. The result of executing any body statements can be retrieved using the
childrenRun
method.
public static final int FLAG_SKIP_SECURITY_CHECK
public static final int FLAG_LOOPING
childrenRun
.
public static final int FLAG_NO_GLOBAL_IMPORT
public static final int FLAG_DEPRECATED
public static final int FLAG_USER1
tagSetFlag
,
tagHasFlag
, tagClearFlag
OR
typeSetFlag
,
typeHasFlag
, typeClearFlag
public static final int FLAG_USER2
tagSetFlag
,
tagHasFlag
, tagClearFlag
OR
typeSetFlag
,
typeHasFlag
, typeClearFlag
public static final int FLAG_USER3
tagSetFlag
,
tagHasFlag
, tagClearFlag
OR
typeSetFlag
,
typeHasFlag
, typeClearFlag
public static final int FLAG_USER4
tagSetFlag
,
tagHasFlag
, tagClearFlag
OR
typeSetFlag
,
typeHasFlag
, typeClearFlag
Constructor Detail |
protected LassoTagModule()
Method Detail |
protected void registerTagModule(java.lang.String moduleName, java.lang.String tagName, java.lang.String methodName, int flags, java.lang.String description)
registerTagModule
as many times as there are tags implemented in your module.
moduleName
- name of the module as returned by [Lasso_TagModuleName]
LDML tagtagName
- name of the custom LDML tag implemented by this modulemethodName
- Lasso will call this method every time it finds tagName
tag in a xxx.lasso
format fileflags
- one or more logically or'ed FLAG
constantsdescription
- optional tag info, such as brief description of this tag usagepublic int TAG_METHOD_PROTOTYPE(LassoCall lasso, int action)
registerTagModule
.
Since methods are being registered by name, they must exactly match
the values passed in a tagName
parameter of registerTagModule
call.
action
- reserved for future use;
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |