Package org.silverpeas.web.clipboard.control

Class ClipboardSessionController

java.lang.Object

org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

org.silverpeas.web.clipboard.control.ClipboardSessionController

All Implemented Interfaces:

Serializable, ComponentSessionController, SessionCloseable

public class ClipboardSessionController
extends AbstractComponentSessionController

A servlet ClipboardSessionController acts as a proxy for a Clipboard Service.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

context

Constructor Summary

Constructors

Constructor	Description
ClipboardSessionController(MainSessionController mainSessionCtrl, ComponentContext context)

Method Summary

Modifier and Type	Method	Description
void	doIdle(int inc)
String	getComponentLabel(String componentId)	Returns the label of the given component
String	getComponentRooterName()
int	getCounter()
String	getHTMLFormForHiddenFrame(javax.servlet.http.HttpServletRequest request)
String	getIntervalInSec()
String	getJavaScriptTaskForHiddenFrame(javax.servlet.http.HttpServletRequest request)
String	getJSPPage()
String	getMessageError()
Collection<ClipboardSelection>	getObjects()	Return the list of object in clipboard.
org.silverpeas.kernel.bundle.SettingBundle	getSettings()
String	getTargetFrame()
void	incCounter(int inc)
void	setComponentId(String componentId)
void	setComponentRooterName(String rooterName)
void	setJSPPage(String jspPage)
void	setSpaceId(String spaceId)
void	setTargetFrame(String targetFrame)

Methods inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

addClipboardSelection, clipboardPasteDone, close, getClipboardErrorMessage, getClipboardExceptionError, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getHighestSilverpeasUserRole, getIcon, getLanguage, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoles, getZoneId, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardSelectedElement, setComponentRootName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipboardSessionController

public ClipboardSessionController(MainSessionController mainSessionCtrl,
                                  ComponentContext context)

Method Detail

getCounter

public int getCounter()

incCounter

public void incCounter(int inc)

doIdle

public void doIdle(int inc)

getJavaScriptTaskForHiddenFrame

public String getJavaScriptTaskForHiddenFrame(javax.servlet.http.HttpServletRequest request)

getHTMLFormForHiddenFrame

public String getHTMLFormForHiddenFrame(javax.servlet.http.HttpServletRequest request)

getMessageError

public String getMessageError()

getObjects

public Collection<ClipboardSelection> getObjects()
                                          throws ClipboardException

Return the list of object in clipboard.

Returns:

the list of object in clipboard.

Throws:

ClipboardException - if an error occurs

getSettings

public org.silverpeas.kernel.bundle.SettingBundle getSettings()

Specified by:

getSettings in interface ComponentSessionController

Overrides:

getSettings in class AbstractComponentSessionController

getComponentLabel

public String getComponentLabel(String componentId)

Returns the label of the given component

Parameters:

componentId - the unique identifier of a component instance.

Returns:

the label of the given component instance.

setComponentRooterName

public void setComponentRooterName(String rooterName)

setSpaceId

public void setSpaceId(String spaceId)

setComponentId

public void setComponentId(String componentId)

setJSPPage

public void setJSPPage(String jspPage)

setTargetFrame

public void setTargetFrame(String targetFrame)

getComponentRooterName

public String getComponentRooterName()

getJSPPage

public String getJSPPage()

getTargetFrame

public String getTargetFrame()

getIntervalInSec

public String getIntervalInSec()