com.sapportals.wcm.rendering.base
Class AbstractResourceListEvent

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.base_api.jar]

com.sapportals.wcm.rendering.base.AbstractProxyEvent
  |
  +--com.sapportals.wcm.rendering.base.AbstractResourceListEvent

public abstract class AbstractResourceListEvent

extends AbstractProxyEvent

This class is used to for complex screenflows that use an AbstractProxyControl as a control in a pane of the screenflow. It allows to send information on the resourcelist or the parent-resource to render. It also holds an instance of an IUIBaseCommand that will be executed within this screenflow.

Constructor Summary

AbstractResourceListEvent(com.sapportals.wcm.control.base.Habitat habitat, java.lang.String explanationtext, IUIBaseCommand command)
creates a new event.

AbstractResourceListEvent(IResourceList list, java.lang.String startUri, java.lang.String explanationtext, IUIBaseCommand command)
creates a new event.

AbstractResourceListEvent(RID rid, java.lang.String startUri, java.lang.String explanationtext, IUIBaseCommand command)
creates a new event.

Method Summary

java.lang.String	getExplanationtext()
IResourceList	getList()
RID	getRID()
java.lang.String	getStartUri()
IUIBaseCommand	getUICommand()
void	setExplanationtext(java.lang.String text) sets the explanation text attribute
void	setResourceList(IResourceList list) sets the resource list attribute
void	setRID(RID rid)
void	setStartUri(java.lang.String startUri) sets the start uri attribute

Constructor Detail

AbstractResourceListEvent

public AbstractResourceListEvent(RID rid,
                                 java.lang.String startUri,
                                 java.lang.String explanationtext,
                                 IUIBaseCommand command)

creates a new event.

Parameters:

rid - - the resource's rid that acts as parent-resource for the receiving control

starturi - - the highest ancestor of the given resource the user can navigate to.

explanationtext - - information for the user on how to proceed when carrying out the action.

command - - the command that is active during the screenflow

AbstractResourceListEvent

public AbstractResourceListEvent(IResourceList list,
                                 java.lang.String startUri,
                                 java.lang.String explanationtext,
                                 IUIBaseCommand command)

creates a new event.

Parameters:

list - - the resources that are displayed by the receiving control

starturi - - the highest ancestor the user can navigate to.

explanationtext - - information for the user on how to proceed when carrying out the action.

command - - the command that is active during the screenflow

AbstractResourceListEvent

public AbstractResourceListEvent(com.sapportals.wcm.control.base.Habitat habitat,
                                 java.lang.String explanationtext,
                                 IUIBaseCommand command)

creates a new event.

Parameters:

list - - the resources that are displayed by the receiving control

starturi - - the highest ancestor the user can navigate to.

explanationtext - - information for the user on how to proceed when carrying out the action.

command - - the command that is active during the screenflow

Method Detail

setExplanationtext

public void setExplanationtext(java.lang.String text)

sets the explanation text attribute

Parameters:

text - - the explantion to show within the screenflow

getExplanationtext

public java.lang.String getExplanationtext()

Returns:

the explanation text attribute, can be null

getUICommand

public IUIBaseCommand getUICommand()

Returns:

the encapsulated command, can be null

setRID

public void setRID(RID rid)

getRID

public RID getRID()

Returns:

the RID of the IResource to render, can be null

getList

public IResourceList getList()

Returns:

the list of resources to render, can be null

setResourceList

public void setResourceList(IResourceList list)

sets the resource list attribute

Parameters:

list - - the resource list to display by the receiving control

setStartUri

public void setStartUri(java.lang.String startUri)

sets the start uri attribute

Parameters:

startUri - - the highest folder in the hiearchy the user may navigate to

getStartUri

public java.lang.String getStartUri()

Returns:

the highest folder in the hierarchy the user may navigate to, can be null