org.exoplatform.social.webui.profile.settings

Class UIIMControlRenderer

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.social.webui.profile.settings.UIIMControlRenderer

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public abstract class UIIMControlRenderer
extends org.exoplatform.container.component.BaseComponentPlugin

Renderer for IMType's value control in user profile. IM value control is optional. This class already a component plugin for use with UserProfileRenderingService.
Created by The eXo Platform SAS

Version:

$Id: UIIMTypeControlRenderer.java 00000 May 4, 2017 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
static String	IM_TYPE_ID The Constant IM_TYPE_ID.
protected org.exoplatform.social.core.profile.settings.IMType	imType The IM type for this renderer.

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Modifier	Constructor and Description
	UIIMControlRenderer(org.exoplatform.social.core.profile.settings.IMType imtype) Instantiates a new IM type renderer without configuration.
protected	UIIMControlRenderer(org.exoplatform.social.core.profile.settings.UserProfileSettingsService settingsService, org.exoplatform.container.xml.InitParams initParams) Instantiates a new IM type renderer from configuration's parameters.

Method Summary

Modifier and Type	Method and Description
protected static org.exoplatform.social.core.profile.settings.IMType	findIMType(String imtId, org.exoplatform.social.core.profile.settings.UserProfileSettingsService settingsService) Finds the IM type.
org.exoplatform.social.core.profile.settings.IMType	getType() Gets the IM type associated with this renderer.
protected static String	readTypeID(org.exoplatform.container.xml.InitParams initParams) Read type ID.
abstract void	render(String imValue, org.exoplatform.webui.application.WebuiRequestContext context) Add required page markup (HTML), styles, scripts or perform other UI manipulations for given IM value (account).

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

IM_TYPE_ID

public static final String IM_TYPE_ID

The Constant IM_TYPE_ID.

See Also:

Constant Field Values

imType

protected final org.exoplatform.social.core.profile.settings.IMType imType

The IM type for this renderer.

Constructor Detail

UIIMControlRenderer

protected UIIMControlRenderer(org.exoplatform.social.core.profile.settings.UserProfileSettingsService settingsService,
                              org.exoplatform.container.xml.InitParams initParams)
                       throws org.exoplatform.container.configuration.ConfigurationException

Instantiates a new IM type renderer from configuration's parameters.

Parameters:

settingsService - the settings service

initParams - the init params

Throws:

org.exoplatform.container.configuration.ConfigurationException - the configuration exception

UIIMControlRenderer

public UIIMControlRenderer(org.exoplatform.social.core.profile.settings.IMType imtype)

Instantiates a new IM type renderer without configuration.

Parameters:

imtype - the imtype

Method Detail

readTypeID

protected static String readTypeID(org.exoplatform.container.xml.InitParams initParams)
                            throws org.exoplatform.container.configuration.ConfigurationException

Read type ID.

Parameters:

initParams - the init params

Returns:

the string

Throws:

org.exoplatform.container.configuration.ConfigurationException - if IM type ID not configured

findIMType

protected static org.exoplatform.social.core.profile.settings.IMType findIMType(String imtId,
                                                                                org.exoplatform.social.core.profile.settings.UserProfileSettingsService settingsService)
                                                                         throws org.exoplatform.container.configuration.ConfigurationException

Finds the IM type.

Parameters:

imtId - the imt id

settingsService - the settings service

Returns:

the IM type, never null

Throws:

org.exoplatform.container.configuration.ConfigurationException - if IM type not found in UserProfileSettingsService

getType

public org.exoplatform.social.core.profile.settings.IMType getType()

Gets the IM type associated with this renderer.

Returns:

the IM type, never null

render

public abstract void render(String imValue,
                            org.exoplatform.webui.application.WebuiRequestContext context)
                     throws IOException,
                            Exception

Add required page markup (HTML), styles, scripts or perform other UI manipulations for given IM value (account).

Parameters:

imValue - the IM value

context - the WebUI context

Throws:

IOException - Signals that an I/O exception has occurred.

Exception - the exception