com.sapportals.wcm.control.navigation

Class LinkListControl

java.lang.Object

com.sapportals.wdf.stack.Control

com.sapportals.wcm.control.base.WcmBaseControl

com.sapportals.wcm.control.base.WcmResourceControl

com.sapportals.wcm.control.navigation.LinkListControl

All Implemented Interfaces:

IControlLinkHandler, com.sapportals.wdf.event.WdfEventReceiver

public class LinkListControl
extends WcmResourceControl
implements com.sapportals.wdf.event.WdfEventReceiver, IControlLinkHandler

The class implements a WCM control that displays the content of a collection. Each resource is in the collection is represented by the image for the corresponding mime type and a link for the resource description. If the link is a link to a collection or a non-collection resource a new browser window is started that displays the content of the resource. For a collection the resource list control is started and for the document the content is displayed. If the displayed hyperlink is a collection (not a link to the collection) the control displays the children of the collection and the navigation path is displayed. The link list control supports different types of link lists:

• user favorites (the user's favorites that are stored in the userhome repository are displayed)
• application-specific (the application-specific collection is retrieved by the orderedListService)
• standard collection (any collection)

Documents link are not displayed as links because every document is processed as link. Additionally the controls provide a button for editing the link list, if the user has the write permission for the collection. Copyright 2004 SAP AG

Nested Class Summary

Nested classes/interfaces inherited from class com.sapportals.wcm.control.base.WcmResourceControl

WcmResourceControl.ResourceNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ON_EDIT

Fields inherited from class com.sapportals.wcm.control.base.WcmResourceControl

START_PAGE_BROWSE, START_PAGE_DETAILS, uri

Fields inherited from class com.sapportals.wcm.control.base.WcmBaseControl

BLANK_LINK_TARGET, CELL_PADDING_STANDARD, CELL_SPACING_STANDARD, CONTROL_HEADER_STANDARD, DETAILS_CONFIG_FILE, NONE, RES_BUTTON_ADD, RES_BUTTON_APPLY, RES_BUTTON_BACK, RES_BUTTON_CANCEL, RES_BUTTON_CLOSE, RES_BUTTON_LOAD, RES_BUTTON_MORE, RES_BUTTON_OK, RES_BUTTON_REMOVE, RES_BUTTON_SAVE, RES_BUTTON_SELECT, RES_BUTTON_UPDATE, resourceContext, SUMMARY

Fields inherited from class com.sapportals.wdf.stack.Control

id

Constructor Summary

Constructors

Constructor and Description
LinkListControl()

Method Summary

Modifier and Type	Method and Description
String	createLink(IResource resource) Creates the links to resources for the embedded resource list.
protected void	createNestedControls()
boolean	getDetailsLinkTarget()
boolean	getDisplayFavorites()
boolean	getForceCollectionCreation()
protected IUriReference	getNavigationPageUri(String uri, String startPage)
String	getStartRoot()
com.sapportals.wdf.event.WdfEvent	onEdit(com.sapportals.htmlb.event.Event event) Call the edit dialog for the corresponding resource
void	receive(com.sapportals.wdf.event.WdfEvent cflEvent) Reacts on CflResourceEvents and resets the present resource of the control.
com.sapportals.htmlb.Component	render()
void	setDetailsLinkTarget(boolean displayLinkTarget)
void	setDisplayFavorites(boolean flag)
void	setForceCollectionCreation(boolean flag)
void	setStartRoot(String newStartRoot)

Methods inherited from class com.sapportals.wcm.control.base.WcmResourceControl

checkArchivingStauts, getAOStates, getDetailsPageUri, getResource, getResourceLink, getResourceList, getSafeResource, getUri, setResource, setUri

Methods inherited from class com.sapportals.wcm.control.base.WcmBaseControl

getBaseBundleString, getBaseBundleString, getBaseBundleString, getBaseBundleString, getBundleString, getBundleString, getBundleString, getBundleString, getBusinessCardLink, getImage, getParameterConfiguration, getResourceContext, getServicePageUri, handleException, isSection508Rendering, isTestMode, isVisible, readInputData, setControlContext, setResourceContext, setTestMode, setVisible

Methods inherited from class com.sapportals.wdf.stack.Control

create, create, createUnequivocallyComponentId, dispatchHtmlbEvent, dispatchWdfEvent, getControlContext, getDynPage, getID, getParent, getPersistenceComponentManager, getRootControl, getStackId, initialize, initializeImpl, isInitialized, register, renderPersistentProperties, resetNestedControls, restorePersistentProperties, restoreProperties, setID, setInitialized, setParent, setStackId, triggerInput

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_ON_EDIT

public static final String EVENT_ON_EDIT

See Also:

Constant Field Values

Constructor Detail

LinkListControl

public LinkListControl()

Method Detail

createNestedControls

protected void createNestedControls()
                             throws com.sapportals.wdf.WdfException

Overrides:

createNestedControls in class com.sapportals.wdf.stack.Control

Throws:

com.sapportals.wdf.WdfException

createLink

public String createLink(IResource resource)

Creates the links to resources for the embedded resource list.

Specified by:

createLink in interface IControlLinkHandler

onEdit

public com.sapportals.wdf.event.WdfEvent onEdit(com.sapportals.htmlb.event.Event event)
                                         throws WcmException

Call the edit dialog for the corresponding resource

Throws:

WcmException

receive

public void receive(com.sapportals.wdf.event.WdfEvent cflEvent)
             throws com.sapportals.wdf.WdfException

Description copied from class: WcmResourceControl

Reacts on CflResourceEvents and resets the present resource of the control. If controls want to implement a special treatment of these events they can implement this method themselves.

Specified by:

receive in interface com.sapportals.wdf.event.WdfEventReceiver

Overrides:

receive in class WcmResourceControl

Parameters:

cflEvent - the event

Throws:

com.sapportals.wdf.WdfException - if an error occurs

render

public com.sapportals.htmlb.Component render()
                                      throws com.sapportals.wdf.WdfException

Specified by:

render in class com.sapportals.wdf.stack.Control

Throws:

com.sapportals.wdf.WdfException

setDisplayFavorites

public void setDisplayFavorites(boolean flag)
                         throws com.sapportals.wdf.WdfException

Throws:

com.sapportals.wdf.WdfException

getDisplayFavorites

public boolean getDisplayFavorites()

setForceCollectionCreation

public void setForceCollectionCreation(boolean flag)

getForceCollectionCreation

public boolean getForceCollectionCreation()

setDetailsLinkTarget

public void setDetailsLinkTarget(boolean displayLinkTarget)

getDetailsLinkTarget

public boolean getDetailsLinkTarget()

setStartRoot

public void setStartRoot(String newStartRoot)

getStartRoot

public String getStartRoot()

getNavigationPageUri

protected IUriReference getNavigationPageUri(String uri,
                                             String startPage)
                                      throws com.sapportals.wdf.WdfException

Throws:

com.sapportals.wdf.WdfException