org.apache.myfaces.component
Interface UserRoleAware

All Known Implementing Classes:

AbstractDiv, AbstractFieldset, AbstractHtmlCheckbox, AbstractHtmlCollapsiblePanel, AbstractHtmlCommandButton, AbstractHtmlCommandJSCookMenu, AbstractHtmlCommandLink, AbstractHtmlCommandNavigation, AbstractHtmlCommandNavigationItem, AbstractHtmlCommandSortHeader, AbstractHtmlDataList, AbstractHtmlDataScroller, AbstractHtmlDataTable, AbstractHtmlGraphicImage, AbstractHtmlHeaderLink, AbstractHtmlInputCalendar, AbstractHtmlInputDate, AbstractHtmlInputFileUpload, AbstractHtmlInputSecret, AbstractHtmlInputText, AbstractHtmlInputTextarea, AbstractHtmlInputTextHelp, AbstractHtmlMessage, AbstractHtmlMessages, AbstractHtmlOutputLabel, AbstractHtmlOutputText, AbstractHtmlPanelGrid, AbstractHtmlPanelGroup, AbstractHtmlPanelNavigationMenu, AbstractHtmlPanelTab, AbstractHtmlPanelTabbedPane, AbstractHtmlPopup, AbstractHtmlRadio, AbstractHtmlSchedule, AbstractHtmlSelectBooleanCheckbox, AbstractHtmlSelectManyCheckbox, AbstractHtmlSelectManyListbox, AbstractHtmlSelectManyMenu, AbstractHtmlSelectManyPicklist, AbstractHtmlSelectOneListbox, AbstractHtmlSelectOneMenu, AbstractHtmlSelectOneRadio, AbstractHtmlTag, AbstractSelectOneCountry, AbstractSelectOneLanguage, AbstractStylesheet, AbstractUINavigationMenuItem, Div, Fieldset, HtmlCheckbox, HtmlCollapsiblePanel, HtmlCommandButton, HtmlCommandJSCookMenu, HtmlCommandLink, HtmlCommandNavigation, HtmlCommandNavigationItem, HtmlCommandSortHeader, HtmlDataList, HtmlDataScroller, HtmlDataTable, HtmlGraphicImage, HtmlHeaderLink, HtmlInputCalendar, HtmlInputDate, HtmlInputFileUpload, HtmlInputSecret, HtmlInputText, HtmlInputTextarea, HtmlInputTextHelp, HtmlMessage, HtmlMessages, HtmlOutputLabel, HtmlOutputText, HtmlPanelGrid, HtmlPanelGroup, HtmlPanelNavigationMenu, HtmlPanelTab, HtmlPanelTabbedPane, HtmlPopup, HtmlRadio, HtmlSchedule, HtmlSelectBooleanCheckbox, HtmlSelectManyCheckbox, HtmlSelectManyListbox, HtmlSelectManyMenu, HtmlSelectManyPicklist, HtmlSelectOneListbox, HtmlSelectOneMenu, HtmlSelectOneRadio, HtmlTag, InputHtml, SelectOneCountry, SelectOneLanguage, Stylesheet, UINavigationMenuItem

public interface UserRoleAware

Behavioral interface. Components that support user role checking should implement this interface to optimize property access.

Version:

$Revision: 659874 $ $Date: 2008-05-24 15:59:15 -0500 (Sat, 24 May 2008) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary

static java.lang.String	ENABLED_ON_USER_ROLE_ATTR
static java.lang.String	VISIBLE_ON_USER_ROLE_ATTR

Method Summary

java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
void	setEnabledOnUserRole(java.lang.String userRole)
void	setVisibleOnUserRole(java.lang.String userRole)

Field Detail

ENABLED_ON_USER_ROLE_ATTR

static final java.lang.String ENABLED_ON_USER_ROLE_ATTR

See Also:

Constant Field Values

VISIBLE_ON_USER_ROLE_ATTR

static final java.lang.String VISIBLE_ON_USER_ROLE_ATTR

See Also:

Constant Field Values

Method Detail

getEnabledOnUserRole

java.lang.String getEnabledOnUserRole()

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

void setEnabledOnUserRole(java.lang.String userRole)

getVisibleOnUserRole

java.lang.String getVisibleOnUserRole()

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

void setVisibleOnUserRole(java.lang.String userRole)