 |
Frame
HTTP
RoxenLib
Module
AbstractLocationModule
RoxenConfiguration
RoxenRequest
RoxenResponse
RoxenFileResponse
RoxenStringResponse
RoxenRXMLResponse
ExperimentalModule
FileExtensionModule
LocationModule
ParserModule
ProviderModule
SecurityModule
SimpleTagCaller
UniqueModule
 |
 |
SimpleTagCaller
: Interface SimpleTagCaller
com.roxen.roxen
Interface SimpleTagCaller
- public abstract interface SimpleTagCaller
The interface for handling a single specific RXML tag
- See Also:
ParserModule
Field Summary |
static int |
FLAG_DONT_PREPARSE
Don't preparse the content with the PHtml parser. |
static int |
FLAG_EMPTY_ELEMENT
If set, the tag doesn't accept content. |
static int |
FLAG_NO_PREFIX
Never apply any prefix to this tag. |
static int |
FLAG_NONE
The no-flags flag. |
static int |
FLAG_POSTPARSE
Postparse the result with the PHtml parser. |
static int |
FLAG_STREAM
The same as specifying both FLAG_STREAM_RESULT and FLAG_STREAM_CONTENT |
static int |
FLAG_STREAM_CONTENT
If set, the tag supports getting its content in streaming mode:
tagCalled will be called repeatedly with successive
parts of the content then. |
static int |
FLAG_STREAM_RESULT
If set, the tagCalled method will be called repeatedly until
it returns null or no more content is wanted. |
Method Summary |
int |
queryTagFlags()
Return the mode flags for the tag handled by this caller object |
java.lang.String |
queryTagName()
Return the name of the tag handled by this caller object |
java.lang.String |
tagCalled(java.lang.String tag,
java.util.Map args,
java.lang.String contents,
RoxenRequest id,
Frame frame)
Handle a call to the tag handled by this caller object |
FLAG_NONE
public static final int FLAG_NONE
- The no-flags flag. In case you think 0 is too ugly.
FLAG_EMPTY_ELEMENT
public static final int FLAG_EMPTY_ELEMENT
- If set, the tag doesn't accept content.
FLAG_NO_PREFIX
public static final int FLAG_NO_PREFIX
- Never apply any prefix to this tag.
FLAG_DONT_PREPARSE
public static final int FLAG_DONT_PREPARSE
- Don't preparse the content with the PHtml parser.
FLAG_POSTPARSE
public static final int FLAG_POSTPARSE
- Postparse the result with the PHtml parser.
FLAG_STREAM_RESULT
public static final int FLAG_STREAM_RESULT
- If set, the tagCalled method will be called repeatedly until
it returns null or no more content is wanted.
FLAG_STREAM_CONTENT
public static final int FLAG_STREAM_CONTENT
- If set, the tag supports getting its content in streaming mode:
tagCalled will be called repeatedly with successive
parts of the content then.
Note: It might be obvious, but using streaming is significantly
less effective than nonstreaming, so it should only be done when
big delays are expected.
FLAG_STREAM
public static final int FLAG_STREAM
- The same as specifying both FLAG_STREAM_RESULT and FLAG_STREAM_CONTENT
queryTagName
public java.lang.String queryTagName()
- Return the name of the tag handled by this caller object
-
- Returns:
- the name of the tag
queryTagFlags
public int queryTagFlags()
- Return the mode flags for the tag handled by this caller object
-
- Returns:
- bitwise or of all flags that apply
tagCalled
public java.lang.String tagCalled(java.lang.String tag,
java.util.Map args,
java.lang.String contents,
RoxenRequest id,
Frame frame)
- Handle a call to the tag handled by this caller object
-
- Parameters:
tag - the name of the tag
args - any attributes given to the tag
contents - the contents of the tag
id - the request object
frame - the parse frame
- Returns:
- the result of handling the tag
|
|