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)	The ClipboardSessionController is built empty and will be later initialized.

Method Summary

Modifier and Type	Method	Description
void	doIdle(int nbinc)	Method doIdle
String	getComponentLabel(String componentId)	Returns the label of the given component
String	getComponentRooterName()
int	getCounter()	Method getCounter
String	getHTMLFormForHiddenFrame(javax.servlet.http.HttpServletRequest request)	Method getJavaScriptTask
Collection<IndexEntry>	getIndexEntryObjects()	Return the list of object (IndexEntry format) in clipboard.
String	getIntervalInSec()	Method declaration
String	getJavaScriptTaskForHiddenFrame(javax.servlet.http.HttpServletRequest request)	Method getJavaScriptTask
String	getJSPPage()
String	getMessageError()
Collection<ClipboardSelection>	getObjects()	Return the list of object in clipboard.
SettingBundle	getSettings()
String	getSpaceLabel(String spaceId)	Returns the label of the given domain/space
String	getTargetFrame()
void	incCounter(int inc)	Method incCounter
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)

The ClipboardSessionController is built empty and will be later initialized.

Parameters:

mainSessionCtrl -

context -

Method Detail

getCounter

public int getCounter()

Method getCounter

Returns:

incCounter

public void incCounter(int inc)

Method incCounter

Parameters:

inc -

doIdle

public void doIdle(int nbinc)

Method doIdle

Parameters:

nbinc -

getJavaScriptTaskForHiddenFrame

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

Method getJavaScriptTask

Parameters:

request -

Returns:

getHTMLFormForHiddenFrame

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

Method getJavaScriptTask

Parameters:

request -

Returns:

getMessageError

public String getMessageError()

getIndexEntryObjects

public Collection<IndexEntry> getIndexEntryObjects()
                                            throws ClipboardException

Return the list of object (IndexEntry format) in clipboard.

Returns:

the list of object (IndexEntry format) in clipboard.

Throws:

RemoteException

ClipboardException

getObjects

public Collection<ClipboardSelection> getObjects()
                                          throws ClipboardException

Return the list of object in clipboard.

Returns:

the list of object in clipboard.

Throws:

RemoteException

NamingException

SQLException

ClipboardException

getSettings

public SettingBundle getSettings()

Specified by:

getSettings in interface ComponentSessionController

Overrides:

getSettings in class AbstractComponentSessionController

getSpaceLabel

public String getSpaceLabel(String spaceId)

Returns the label of the given domain/space

Parameters:

spaceId -

Returns:

the label of the given domain/space

getComponentLabel

public String getComponentLabel(String componentId)

Returns the label of the given component

Parameters:

componentId -

Returns:

setComponentRooterName

public void setComponentRooterName(String rooterName)

Parameters:

rooterName -

setSpaceId

public void setSpaceId(String spaceId)

setComponentId

public void setComponentId(String componentId)

setJSPPage

public void setJSPPage(String jspPage)

Parameters:

jspPage -

setTargetFrame

public void setTargetFrame(String targetFrame)

Parameters:

targetFrame -

getComponentRooterName

public String getComponentRooterName()

Returns:

getJSPPage

public String getJSPPage()

Returns:

getTargetFrame

public String getTargetFrame()

Returns:

getIntervalInSec

public String getIntervalInSec()

Method declaration

Returns: