com.Yasna.forum.tags |
|
Java Source File Name | Type | Comment |
AccountTag.java | Class | JSP Tag account, used to modify a Yazd User account. |
AccountTEI.java | Class | |
AdminUserTag.java | Class | JSP Tag admin, used to perform user admin level functions
on a user that is not logged in or not authorized for the function. |
AllowPrivateReplyTag.java | Class | Jsp tag must be nested in Message tag. |
AnonymousMessageTag.java | Class | JSP Tag anonymous_message, used to test if the user
who authored a message anonymous user. |
AnonymousUserTag.java | Class | JSP Tag anonymous_user, used to test for an anonymous user. |
AuthorizeTag.java | Class | JSP Tag authorize, used to authorize a Yazd user session. |
AuthorizeTEI.java | Class | |
BooleanTag.java | Interface | |
CalcTag.java | Class | JSP Tag calc, used to calculate and return an integer value. |
CanReadPrivateTag.java | Class | |
CaseTag.java | Class | Used as nested tag in ancestors of BooleanTag interface.
Takes one parameter [value]. |
CategoriesLoopTag.java | Class | Jsp tag used to iterate through categories in database.
Implements the BooleanTag interface and its single method getValue()
returns true if any category exits in the database. |
ChangeForum.java | Interface | Interface used by post, thread, and forum tags
which allows the change_forum tag to set what
forum to post or move a message to, or what the current forum is. |
ChangeForumTag.java | Class | JSP Tag change_forum, used with post or thread tag to set
an alternate forum id to post message or move message to, or a forum tag to change forum being viewed. |
ChangeThreadTag.java | Class | JSP Tag change_thread, used with thread tag to
change to a different thread. |
CreateTag.java | Class | JSP Tag create, used to create a new Yazd User account. |
CreateTEI.java | Class | |
CurrentDepthTag.java | Class | JSP Tag current_depth, returns the current message depth
while walking a message tree. |
ErrorLoopTag.java | Class | JSP Tag error_loop, used to loop through the previous request
list of user errors. |
ErrorLoopTEI.java | Class | |
ErrorTag.java | Class | JSP Tag if_error, used to test for a user error. |
EvalTag.java | Class | JSP Tag eval, used to evaluate a comparison of two strings or
integers.
Requires that attribute id be set to the name of a
script variable for later use by the true or false tags.
Valid comparison operators for integers are == (equal), !=
(not equal), >= (greater than or equal),
<= (less than or equal), < (less than),
and > (greater than).
Valid comparison operators for strings include all those for an integer
plus |= (first string is a prefix of second string),
|! (first string is not a prefix of second string),
=| (first string is a suffix of second string),
and !| (first string is not a suffix of second string).
When comparing strings that might include white space, use the forward
slash \ at the start and end of the string.
The values being compared must be separated from the comparison operator
by white space.
Any JSP tags embedded in the body of the eval tag are processed
before the comparison is made.
The true and false tags are used to take action based on the
result of the eval comparison.
Examples:
Compare the number of forums to 0.
<jf:eval id="num_forums">
<jsp:getProperty name="req" property="numberOfForums"/> == 0
</jf:eval>
Compares the prefix "Re: " to a message subject line.
<jf:eval id="sub">
\Re: \ |= \<jsp:getProperty name="cm" property="subject"/>\
</jf:eval>
JSP Tag Lib Descriptor
<name>eval</name>
<tagclass>com.Yasna.forum.tags.EvalTag</tagclass>
<bodycontent>JSP</bodycontent>
<info>Compares two values, use the true and false tags to test result of eval. |
FalseTag.java | Class | JSP Tag false, used to test the result of an eval tag
for false. |
ForEachTag.java | Class | JSP Tag foreach, used to implement a simple numbered loop. |
ForEachTEI.java | Class | |
ForumLoopTag.java | Class | JSP Tag forum_loop, used to loop through available forums.
Optional attribute begin can be set to the number at
which the forum_loop should start.
Optional attribute end can be set to the number at
which the forum_loop should end.
Optional attribute match can be set to the id of
a match tag to select only those forums that match the
forum extended properties specified by the match tag.
During each loop the body of the forum_loop tag is processed.
The on_entry tag can be used to include content if this is
the first time through the loop.
The on_exit tag can be used to include content if this is
the last time through the loop.
The forum_loop continues looping until there are no more forums
or the users items_per_page limit has been reached. |
ForumsLoopTag.java | Class | Loops through forums in current group. |
ForumTag.java | Class | JSP Tag forum, used to get information about current forum. |
ForumTEI.java | Class | |
GetNestedMessage.java | Interface | Interface used by walk and thread tags to make
it easier for message tag to get the message. |
GetYazdPropertyTag.java | Class | JSP Tag getYazdProperty, used with create,
account, user, forum, post, and message
tags to get a yazd extended property. |
GroupsLoopTag.java | Class | |
IsAdminUserTag.java | Class | |
IsApprovedTag.java | Class | Jsp tag must be nested in Message tag. |
IsMessageTag.java | Class | JSP Tag is_message, used to test if a message is below the
users message_depth display preferences when using the walk tag. |
IsParentTag.java | Class | JSP Tag is_parent, used to test if the current message
is a parent message that was already fully displayed on the
previous page during a thread walk. |
IsPrivateMessageTag.java | Class | Jsp tag must be nested in Message tag. |
IsSummaryTag.java | Class | JSP Tag is_summary, used to test if the current message
while walking a thread is greater than or equal to the users
message_depth but less than the users thread_depth. |
IsTotalTag.java | Class | JSP Tag is_total, used to test if the current message
is greater than or equal to the users thread depth. |
LoginTag.java | Class | JSP Tag login, used to login a Yazd user.
Uses the following HTTP input parameters
- login - indicates user is submitting the login form
- username - Yazd user name (userid) to login
- password - users password
If login fails a user error is set, if login succeeds the body of the
login tag is included and the remainder of the page is skipped.
Initializes YazdState and YazdRequest if necessary.
JSP Tag Lib Descriptor
<name>login</name>
<tagclass>com.Yasna.forum.tags.LoginTag</tagclass>
<bodycontent>JSP</bodycontent>
<info>Login user using username and password. |
LogoutTag.java | Class | JSP Tag logout, logs out a Yazd user and sets their Authorization
to an anonymous user. |
LogTag.java | Class | JSP Tag log, used to log the content of the log
tag body to the servlet context log. |
MatchTag.java | Class | JSP Tag match, used to set extended forum properties
and values which are used by the forum_loop and forum
tags to determine what forums to select. |
MemberOfGroupTag.java | Class | JSP Tag member_of_group, used to test if the user is
a member of a yazd group.
Includes body of tag if user is a member of the group.
Must be nested inside an account tag.
You can set the optional tag attribute value to true or
false. |
MessageLoopTag.java | Class | JSP Tag message_loop, used to loop through messages
returned by a query in the current forum.
Required attribute query is set to the script
variable id of a query tag to search for messages
based on a query.
Must be nested inside a forum tag.
During each loop the body of the message_loop tag is processed.
The on_entry tag can be used to include content if this is
the first time through the loop.
The on_exit tag can be used to include content if this is
the last time through the loop.
The message_loop continues looping until there are no more messages
or the users items_per_page limit has been reached. |
MessageTag.java | Class | JSP Tag message, used to get information about current message. |
MessageTEI.java | Class | |
MoveMessageTag.java | Class | JSP Tag move_message, used with thread tag to
remove current thread and add its message to a parent message
in another forum thread. |
MoveThreadTag.java | Class | JSP Tag move_thread, used with thread tag to
move thread to a different forum. |
NewMessages.java | Interface | Interface used by forum, thread, or
message tags to implement test for new messages. |
NewMessagesTag.java | Class | JSP Tag new_messages, used to test whether a forum,
thread, or message has been modified since the users last
visit to the forum.
Includes body of tag if there is a new message.
You can set the optional tag parameter value to true or
false. |
NextForumTag.java | Class | JSP Tag next_forum, used to test if there is another forum
following the current forum in the list of available forums. |
NextItemTag.java | Class | JSP Tag next_item, used to get the query portion of an HREF get
for paging to the start of the next list of items to display for the
forum_loop, thread_loop, message_loop,
or walk tag. |
NextPageTag.java | Class | JSP Tag next_page, used to test if a forum_loop,
thread_loop, message_loop, or walk tag has
reached the items_per_page limit and would need another page to
display more items. |
NextThreadTag.java | Class | JSP Tag next_thread, used to test if there is another thread
following the current thread in the current forum. |
NowTag.java | Class | |
OnEntryTag.java | Class | JSP Tag on_entry, used to include content on the first iteration
of a forum_loop, thread_loop, message_loop,
or walk tag. |
OnExitTag.java | Class | JSP Tag on_exit, used to include content on the last iteration
of a forum_loop, thread_loop, message_loop,
or walk tag. |
Paging.java | Interface | Interface used by walk, thread_loop, or
forum_loop tags to implement paging. |
PerformAdminActionTag.java | Class | Jsp tag evaluates its body if curent logged in user is admin or moderator.
Must be nested in Thread or Forum tag. |
PostAppendTag.java | Class | JSP Tag post_append, used with post tag to
append text to the end of the message body.
Must be nested within a post tag.
The body of the tag is used as the text to append to the
body of the message being posted. |
PostMessageTag.java | Class | JSP Tag post_message, used with post tag to
save the message to a forum. |
PostTag.java | Class | JSP Tag post, used to setup for posting a new message or replying
to an existing message using post_message tag. |
PostTEI.java | Class | |
PrevForumTag.java | Class | JSP Tag prev_forum, used to test if there is a forum
preceding the current forum in the list of available forums. |
PreviewMessageTag.java | Class | JSP Tag preview_message, used with message tag to
preview a message before posting to a forum. |
PrevItemTag.java | Class | JSP Tag prev_item, used to get the query portion of an HREF get
for paging to the start of the previous list of items to display for the
forum_loop, thread_loop, message_loop,
or walk tag. |
PrevPageTag.java | Class | JSP Tag prev_page, used to test if a forum_loop,
thread_loop, message_loop, or walk has
reached the items_per_page limit and would need another page
to display more items. |
PrevThreadTag.java | Class | JSP Tag prev_thread, used to test if there is a thread
preceding the current thread in the current forum. |
PrintMessageBodyTag.java | Class | Jsp tag must be nested in message tag. |
QueryTag.java | Class | JSP Tag query, used to set forum message query properties
and values which are used by the message_loop
tag to determine what messages to select. |
RotateSelectionTag.java | Class | JSP Tag rotate_selection, used to define content to be
rotated by a parent rotate tag. |
RotateTag.java | Class | JSP Tag rotate, used to rotate output within a loop. |
RotateTEI.java | Class | |
SetParentMessageTag.java | Class | JSP Tag set_parent_message, used with thread tag to set
the parent message id to move message to. |
SetThreadTag.java | Class | JSP Tag set_thread, used with thread tag to set
the thread id to move message to. |
SetYazdPropertyTag.java | Class | JSP Tag setYazdProperty, used with create,
account, user, forum, message, and
post tags to get a yazd extended property. |
TagPropertyManager.java | Class | Static class used to manage Yazd tag properties and
User extended properties. |
ThreadLoopTag.java | Class | JSP Tag thread_loop, used to loop through available threads
in the current forum.
Optional attribute begin can be set to the number at
which the thread_loop should start.
Optional attribute end can be set to the number at
which the thread_loop should end.
Must be nested inside a forum tag.
During each loop the body of the thread_loop tag is processed.
The on_entry tag can be used to include content if this is
the first time through the loop.
The on_exit tag can be used to include content if this is
the last time through the loop.
The thread_loop continues looping until there are no more threads
or the users items_per_page limit has been reached. |
ThreadTag.java | Class | JSP Tag thread, used to get information about current thread. |
ThreadTEI.java | Class | |
TrueTag.java | Class | JSP Tag true, used to test the result of an eval tag
for true. |
URLEncodeTag.java | Class | Jsp tag encodes the content of its body using UTF-8 and prints it back to
the output stream. |
UserTag.java | Class | JSP Tag user, used to access account information for
a user who posted a message. |
UserTEI.java | Class | |
WalkData.java | Class | Maintains state information while walking a thread tree of
messages. |
WalkTag.java | Class | JSP Tag walk, implements a loop used to walk a tree of
messages in a thread.
Must be nested inside a thread tag.
The thread to walk will be the closest parent thread tag unless
you specify the optional thread tag to be the id
of a different thread tag.
Uses the users display preferences messageDepth,
threadDepth, and itemsPerPage to determine
which messages to display, how to display them, and how
many messages to view on a page before triggering paging.
The is_parent, is_message, is_summary,
is_total, next_page, and prev_page tags
can be used to control what formatted content is generated
based on user display preferences.
The current_depth, while_child, while_new_child,
while_parent, and while_new_parent tags can be used
to assist JSP page author to propertly format HTML output when
displaying a tree of messages in a thread.
During each loop the body of the walk tag is processed.
The on_entry tag can be used to include content if this is
the first time through the loop.
The on_exit tag can be used to include content if this is
the last time through the loop.
The walk tag continues looping until there are no more messages in the
thread or the users items_per_page limit has been reached. |
WhileChildTag.java | Class | JSP Tag while_child, used with the walk tag to iterate
through a loop for each child (depth) message that exists. |
WhileNewChildTag.java | Class | JSP Tag while_new_child, used with the walk tag to iterate
through a loop for each new child (depth) message that exists. |
WhileNewParentTag.java | Class | JSP Tag while_new_parent, used with the walk tag to iterate
through a loop for each new parent (depth) message that exists. |
WhileParentTag.java | Class | JSP Tag while_parent, used with the walk tag to iterate
through a loop for each parent (depth) message that exists. |
YazdProperty.java | Interface | Interface used by create, account, user,
forum, message, and post tags
which allows the getYazdProperty and setYazdPropery tags
to get and set User, Message, and Forum extended yazd properties. |
YazdRequest.java | Class | Maintains Yazd state information for the current request. |
YazdState.java | Class | Maintains Yazd state information for the user session. |