com.ideo.sweetdevria.taglib
Interface IRiaTag

All Known Implementing Classes:

AbstractComponentTagSupport, AbstractTagDrawer, AccordionItemTag, AccordionTag, ActionElseTag, ActionTag, AlertTag, BaseColumnHeaderTag, BaseExportTag, BaseGridExportTag, BaseGridTag, BaseGroupColumnHeaderTag, BaseLinkTagSupport, BaseStateTagSupport, BaseTagSupport, CalendarTag, CollapseHeaderTag, CollapseManagerTag, CollapseTag, ContextMenuTag, ContextTag, ControlTag, DockingColumnTag, DockingLayoutTag, EditableTextTag, FileUploadTag, FrameTag, GridBeanTag, GridColumnHeaderTag, GridColumnTag, GridExportTag, GridGroupColumnHeaderTag, GridInnerExportTag, GridTag, ListTag, MandatoryControlTag, MandatoryTag, MenubarTag, MenuItemTag, MenuTag, MessageTag, MessengerTag, NewWindowTag, ReaderCategoryTag, ReaderItemTag, ReaderTag, ResourcesImportTag, SimpleGridColumnTag, SimpleGridGroupColumnTag, SimpleGridTag, SingleExportTag, SpliterCellTag, SpliterColumnTag, SpliterLayoutTag, SuggestTag, TabboxTag, TabContentTag, TabLayoutTag, TabPanelsTag, TabPanelTag, TabsTag, TabTag, TestTag, TooltipContentTag, TooltipTag, TreeNodeTag, TreeTag, ZoneRefresherTag, ZoneTag

public interface IRiaTag

Method Summary

int	doEndTag() Default processing of the end tag returning EVAL_PAGE.
int	doStartTag() Default processing of the start tag.
java.lang.String	getBuilderId() Return the targeted builder id for this component as specified in the configuration file.
java.util.Map	getMessageKeys() Get messages keys.
javax.servlet.jsp.PageContext	getPageContext() Return the Page Context.
java.lang.String	getTemplateEnd() Get the specific Velocity template path used to render the end part set from taglib attribute.
java.lang.String	getTemplateStart() Get the specific Velocity template path used to render the start part set from taglib attribute.
void	release() Release method which must call super.release !
void	setPageContext(javax.servlet.jsp.PageContext pageContext) Used by HTTP container.
void	setTemplateEnd(java.lang.String templateEnd) Set a specific Velocity template path which will be used to render the end part.
void	setTemplateStart(java.lang.String templateStart) Set a specific Velocity template path which will be used to render the start part.

Method Detail

release

void release()

Release method which must call super.release !

getBuilderId

java.lang.String getBuilderId()

Return the targeted builder id for this component as specified in the configuration file.

Returns:

id targeted builder id

doStartTag

int doStartTag()
               throws javax.servlet.jsp.JspException

Default processing of the start tag.

Returns:

EVAL_BODY_AGAIN, EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY or SKIP_PAGE.

Throws:

javax.servlet.jsp.JspException

doEndTag

int doEndTag()
             throws javax.servlet.jsp.JspException

Default processing of the end tag returning EVAL_PAGE.

Returns:

EVAL_PAGE or SKIP_PAGE.

Throws:

javax.servlet.jsp.JspException

setPageContext

void setPageContext(javax.servlet.jsp.PageContext pageContext)

Used by HTTP container. We should release tag here.

Parameters:

pageContext -

getPageContext

javax.servlet.jsp.PageContext getPageContext()

Return the Page Context.

Returns:

Page context.

getMessageKeys

java.util.Map getMessageKeys()

Get messages keys.

Returns:

Returns messages keys.

getTemplateStart

java.lang.String getTemplateStart()

Get the specific Velocity template path used to render the start part set from taglib attribute. If this attribute is not set, the drawer will use the default velocity template.

Returns:

Velocity template path if set by taglib attribute else, null.

setTemplateStart

void setTemplateStart(java.lang.String templateStart)

Set a specific Velocity template path which will be used to render the start part. If this attribute is not set, the drawer will use the default velocity template.

Parameters:

templateStart - Velocity template path as defined in configuration file (ria-config.xml).

getTemplateEnd

java.lang.String getTemplateEnd()

Get the specific Velocity template path used to render the end part set from taglib attribute. If this attribute is not set, the drawer will use the default velocity template.

Returns:

Velocity template path if set by taglib attribute else, null.

setTemplateEnd

void setTemplateEnd(java.lang.String templateEnd)

Set a specific Velocity template path which will be used to render the end part. If this attribute is not set, the drawer will use the default velocity template.

Parameters:

templateEnd - Velocity template path as defined in configuration file (ria-config.xml).