Package com.jalios.jcms.taglib

Class LangTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

com.jalios.jcms.taglib.LangTag

All Implemented Interfaces:

JcmsConstants, JaliosConstants, java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class LangTag
extends javax.servlet.jsp.tagext.TagSupport
implements JcmsConstants

This tag prints the flag bound to the given language or bound to userLang.

Author:

Olivier Dedieu

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LangTag.LangTagMemento

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARROW_ICON

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
LangTag()

Method Summary

Modifier and Type	Method	Description
static void	appendFlag(java.lang.StringBuffer sb, java.lang.String flagLang, java.lang.String title)
static void	appendFlag(java.lang.StringBuffer sb, java.lang.String flagLang, java.lang.String title, boolean addAlt)
int	doEndTag()
int	doStartTag()
static java.lang.String	getChangeUrl(javax.servlet.http.HttpServletRequest request, java.lang.String lang)	Retrieve an URL used to change to the specified language.
static java.lang.String	getLangForm(java.lang.String userLang)	Returns the lang icon action to display langForm menu.
static java.lang.String	getLangFormMenu()	Returns the lang form menu for doEmptyHeader.jsp
static java.lang.String	getLangIcon(java.lang.String lang)	Retrieve the HTML used to display a flag associated to specified language
void	setCss(java.lang.String css)
void	setCtxMenuCss(java.lang.String ctxMenuCss)
void	setDisplay(java.lang.String display)
void	setLang(java.lang.String lang)
void	setTitle(java.lang.String title)
void	setUseLocalizedLanguageList(boolean use)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

ARROW_ICON

public static final java.lang.String ARROW_ICON

See Also:

Constant Field Values

Constructor Detail

LangTag

public LangTag()

Method Detail

setLang

public void setLang(java.lang.String lang)

setCss

public void setCss(java.lang.String css)

setCtxMenuCss

public void setCtxMenuCss(java.lang.String ctxMenuCss)

setTitle

public void setTitle(java.lang.String title)

setDisplay

public void setDisplay(java.lang.String display)

setUseLocalizedLanguageList

public void setUseLocalizedLanguageList(boolean use)

doStartTag

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

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

public int doEndTag()

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

getLangForm

public static java.lang.String getLangForm(java.lang.String userLang)

Returns the lang icon action to display langForm menu.

Parameters:

userLang - the user language

Returns:

String icon

Since:

jcms-6.1.0

getLangFormMenu

public static java.lang.String getLangFormMenu()

Returns the lang form menu for doEmptyHeader.jsp

Returns:

String LangFormMenu

getLangIcon

public static java.lang.String getLangIcon(java.lang.String lang)

Retrieve the HTML used to display a flag associated to specified language

Parameters:

lang - the ISO-639 language code to be displayed

Returns:

the HTML used to display a lang flag

Since:

jcms-10.0.3 / JCMS-7376

appendFlag

public static void appendFlag(java.lang.StringBuffer sb,
                              java.lang.String flagLang,
                              java.lang.String title)

appendFlag

public static void appendFlag(java.lang.StringBuffer sb,
                              java.lang.String flagLang,
                              java.lang.String title,
                              boolean addAlt)

getChangeUrl

public static java.lang.String getChangeUrl(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String lang)

Retrieve an URL used to change to the specified language.

Parameters:

request - the current request (required, must not be nul)

lang - the target language

Returns:

an URL (relative to webapp root) suitable to change current user browsing language to the specified lang (any ampersand used to seperate paramaters will already be encoded for use in HTML)

Since:

jcms-9.0.0 / JCMS-3387