Class MasonTagTypes

java.lang.Object

MasonTagTypes

public final class MasonTagTypes
extends Object

Contains tag types related to the Mason server platform.

There is no specific tag type defined for the Mason substitution tag as it is recognised using the common server tag type.

The tag types defined in this class are not registered by default. The register() method is provided as a convenient way to register them all at once.

Field Summary

Fields

Modifier and Type	Field	Description
static final StartTagType	MASON_COMPONENT_CALL	The tag type given to a Mason component call (<& ... &>).
static final StartTagType	MASON_COMPONENT_CALLED_WITH_CONTENT	The tag type given to the start tag of a Mason component called with content (<&| ... &> ... </&>).
static final EndTagType	MASON_COMPONENT_CALLED_WITH_CONTENT_END	The tag type given to the end tag of a Mason component called with content.
static final StartTagType	MASON_NAMED_BLOCK	The tag type given to the start tag of a Mason named block (<%name ... > ... </%name>).
static final EndTagType	MASON_NAMED_BLOCK_END	The tag type given to the end tag of a Mason named block.

Method Summary

Modifier and Type	Method	Description
static boolean	defines(TagType tagType)	Indicates whether the specified tag type is defined in this class.
static void	deregister()	Deregisters all of the tag types defined in this class at once.
static boolean	isParsedByMason(TagType tagType)	Indicates whether the specified tag type is recognised by a Mason parser.
static void	register()	Registers all of the tag types defined in this class at once.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MASON_COMPONENT_CALL

public static final StartTagType MASON_COMPONENT_CALL

The tag type given to a Mason component call (<& ... &>).

Properties:

Property	Value
Description	mason component call
StartDelimiter	<&
ClosingDelimiter	&>
IsServerTag	true
NamePrefix	&
CorrespondingEndTagType	null
HasAttributes	false
IsNameAfterPrefixRequired	false

Example:

<& menu &>

MASON_COMPONENT_CALLED_WITH_CONTENT

public static final StartTagType MASON_COMPONENT_CALLED_WITH_CONTENT

The tag type given to the start tag of a Mason component called with content (<&| ... &> ... </&>).

Properties:

Property	Value
Description	mason component called with content
StartDelimiter	<&|
ClosingDelimiter	&>
IsServerTag	true
NamePrefix	&|
CorrespondingEndTagType	MASON_COMPONENT_CALLED_WITH_CONTENT_END
HasAttributes	false
IsNameAfterPrefixRequired	false

Example:

 <&| /sql/select, query => 'SELECT name, age FROM User' &>
  <tr><td>%name</td><td>%age</td></tr>
</&>

MASON_COMPONENT_CALLED_WITH_CONTENT_END

public static final EndTagType MASON_COMPONENT_CALLED_WITH_CONTENT_END

The tag type given to the end tag of a Mason component called with content.

See the corresponding start tag type MASON_COMPONENT_CALLED_WITH_CONTENT for more details.

Properties:

Property/Method	Value
Description	/mason component called with content
StartDelimiter	</&
ClosingDelimiter	>
IsServerTag	true
NamePrefix	/&
CorrespondingStartTagType	MASON_COMPONENT_CALLED_WITH_CONTENT
generateHTML("StartTagName")	</&>

Example:

</&>

See Also:

• MASON_COMPONENT_CALLED_WITH_CONTENT

MASON_NAMED_BLOCK

public static final StartTagType MASON_NAMED_BLOCK

The tag type given to the start tag of a Mason named block (<%name ... > ... </%name>).

A tag of this type must not have a '%' character before its closing delimiter, otherwise it is most likely a common server tag.

For the start tag to be recognised, a corresponding end tag of the correct type must exist somewhere in the source document following the start tag.

Properties:

Property	Value
Description	mason named block
StartDelimiter	<%
ClosingDelimiter	>
IsServerTag	true
NamePrefix	%
CorrespondingEndTagType	MASON_NAMED_BLOCK_END
HasAttributes	false
IsNameAfterPrefixRequired	true

Example:

<%perl> print "hello world"; </%perl>

MASON_NAMED_BLOCK_END

public static final EndTagType MASON_NAMED_BLOCK_END

The tag type given to the end tag of a Mason named block.

See the corresponding start tag type MASON_NAMED_BLOCK for more details.

Properties:

Property/Method	Value
Description	/mason named block
StartDelimiter	</%
ClosingDelimiter	>
IsServerTag	true
NamePrefix	/%
CorrespondingStartTagType	MASON_NAMED_BLOCK
generateHTML("%StartTagName")	</%StartTagName>

Example:

</%perl>

See Also:

• MASON_NAMED_BLOCK

Method Details

register

public static void register()

Registers all of the tag types defined in this class at once.

The tag types must be registered before the parser will recognise them.

deregister

public static void deregister()

Deregisters all of the tag types defined in this class at once.

defines

public static boolean defines(TagType tagType)

Indicates whether the specified tag type is defined in this class.

Parameters:

tagType - the TagType to test.

Returns:

true if the specified tag type is defined in this class, otherwise false.

isParsedByMason

public static boolean isParsedByMason(TagType tagType)

Indicates whether the specified tag type is recognised by a Mason parser.

This is true if the specified tag type is defined in this class or if it is the common server tag type.

Parameters:

tagType - the TagType to test.

Returns:

true if the specified tag type is recognised by a Mason parser, otherwise false.