Package org.opencms.jsp.userdata

Class CmsUserDataHeader

java.lang.Object

org.opencms.jsp.userdata.CmsUserDataHeader

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsUserDataDomain

public class CmsUserDataHeader
extends java.lang.Object
implements I_CmsUserDataDomain

Shows email address / user name as a header.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.jsp.userdata.I_CmsUserDataDomain

I_CmsUserDataDomain.Mode

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsUserDataHeader()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
void	appendInfoHtml(CmsObject cms, CmsUserDataRequestType reqType, java.util.List<CmsUser> user, org.jsoup.nodes.Element element)	Appends the user data to the given HTML element.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	initialize(CmsObject cms)	Initializes the domain with an admin CmsObject.
boolean	isAvailableForMode(I_CmsUserDataDomain.Mode mode)	Checks if the plugin is available in the given mode.
boolean	matchesUser(CmsObject cms, CmsUserDataRequestType reqType, CmsUser user)	Checks if the user matches the domain for the given user data request type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.jsp.userdata.I_CmsUserDataDomain

appendlInfoForEmail

Constructor Detail

CmsUserDataHeader

public CmsUserDataHeader()

Method Detail

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                                      java.lang.String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

appendInfoHtml

public void appendInfoHtml(CmsObject cms,
                           CmsUserDataRequestType reqType,
                           java.util.List<CmsUser> user,
                           org.jsoup.nodes.Element element)

Description copied from interface: I_CmsUserDataDomain

Appends the user data to the given HTML element.

Specified by:

appendInfoHtml in interface I_CmsUserDataDomain

Parameters:

cms - the CMS context

reqType - the request type (email or single user)

user - the list of users (if the request type is singleUser, this has only one element)

element - the HTML element to append the data to

See Also:

I_CmsUserDataDomain.appendInfoHtml(org.opencms.file.CmsObject, org.opencms.jsp.userdata.CmsUserDataRequestType, java.util.List, org.jsoup.nodes.Element)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

I_CmsConfigurationParameterHandler.getConfiguration()

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject cms)

Description copied from interface: I_CmsUserDataDomain

Initializes the domain with an admin CmsObject.

Specified by:

initialize in interface I_CmsUserDataDomain

Parameters:

cms - a CmsObject

See Also:

I_CmsUserDataDomain.initialize(org.opencms.file.CmsObject)

isAvailableForMode

public boolean isAvailableForMode(I_CmsUserDataDomain.Mode mode)

Description copied from interface: I_CmsUserDataDomain

Checks if the plugin is available in the given mode.

Specified by:

isAvailableForMode in interface I_CmsUserDataDomain

Parameters:

mode - the mode

Returns:

true if the plugin is available

See Also:

I_CmsUserDataDomain.isAvailableForMode(org.opencms.jsp.userdata.I_CmsUserDataDomain.Mode)

matchesUser

public boolean matchesUser(CmsObject cms,
                           CmsUserDataRequestType reqType,
                           CmsUser user)

Description copied from interface: I_CmsUserDataDomain

Checks if the user matches the domain for the given user data request type.

Specified by:

matchesUser in interface I_CmsUserDataDomain

Parameters:

cms - the CMS context

reqType - the user data request type (email or single user)

user - the user

Returns:

true if the domain matches the user

See Also:

I_CmsUserDataDomain.matchesUser(org.opencms.file.CmsObject, org.opencms.jsp.userdata.CmsUserDataRequestType, org.opencms.file.CmsUser)