com.sapportals.wcm.control.navigation

Class ResourcePathControl2

java.lang.Object
  com.sapportals.wdf.stack.Control
      com.sapportals.wcm.control.base.WcmBaseControl
          com.sapportals.wcm.control.navigation.ResourcePathControl2

public class ResourcePathControl2
extends WcmBaseControl

Renders path of a RID. Usually used as included control of composite controls.

Field Summary

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

ResourcePathControl2()

Method Summary

com.sapportals.wdf.stack.Control	getController() Get the Controller attribute of the ResourcePathControl2 object.
String	getDifferential() Get the Differential attribute of the ResourcePathControl2 object.
String	getHandler() Get the Handler attribute of the ResourcePathControl2 object.
boolean	getImageVisible() Get the imageVisible attribute of the ResourcePathControl2 object.
String	getPathUri() Get the Uri attribute of the ResourcePathControl2 object.
String	getRootName() Get the RootName attribute of the ResourcePathControl2 object.
String	getStartUri() Get the StartUri attribute of the ResourcePathControl2 object.
boolean	isItemsClickable() Get the ItemsClickable attribute of the ResourcePathControl2 object.
boolean	isLastItemClickable() Get the LastItemClickable attribute of the ResourcePathControl2 object.
boolean	isVirtualRootMode() Get the ListMode attribute of the ResourcePathControl2 object.
com.sapportals.wdf.event.WdfEvent	onDefaultClick(com.sapportals.htmlb.event.Event event) Default onClick Handler.
com.sapportals.htmlb.Component	render() Renders RID as path.
void	setController(com.sapportals.wdf.stack.Control controller) Controller which is responsible to handle click event.
void	setDifferential(String differential) Set the Differential attribute of the ResourcePathControl2 object.
void	setHandler(String handler) Handler which is responsible to handle click event.
void	setImageVisible(boolean imageVisible) Set the ImageVisible attribute of the ResourcePathControl2 object.
void	setItemsClickable(boolean itemsClickable) Makes all items clickable.
void	setLastItemClickable(boolean lastItemClickable) Makes the last path item clickable.
void	setPathUri(String pathUri) Set the Uri attribute of the ResourcePathControl2 object as String type.
void	setRootName(String rootName) Changes the name of the virtual root ("/").
void	setStartUri(String startUri) If null the path starts with the root.
void	setVirtualRootMode(boolean virtualRootMode) In virtual root mode the uri of the root is null.

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, createNestedControls, 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

Constructor Detail

ResourcePathControl2

public ResourcePathControl2()

Method Detail

setDifferential

public void setDifferential(String differential)

Set the Differential attribute of the ResourcePathControl2 object.

Parameters:

differential - - The new Differential value

setImageVisible

public void setImageVisible(boolean imageVisible)

Set the ImageVisible attribute of the ResourcePathControl2 object.

Parameters:

imageVisible - - The Image before the path

setVirtualRootMode

public void setVirtualRootMode(boolean virtualRootMode)

In virtual root mode the uri of the root is null. This is used in the case that a list of uries needs to be rendered. The root of a uri list is virtual.

Parameters:

virtualRootMode - The new VirtualRootMode value

setPathUri

public void setPathUri(String pathUri)

Set the Uri attribute of the ResourcePathControl2 object as String type.

Parameters:

pathUri - The new PathUri value

setLastItemClickable

public void setLastItemClickable(boolean lastItemClickable)

Makes the last path item clickable.

Parameters:

lastItemClickable - The new LastItemClickable value

setItemsClickable

public void setItemsClickable(boolean itemsClickable)

Makes all items clickable.

Parameters:

itemsClickable - The new LastItemClickable value

setStartUri

public void setStartUri(String startUri)

If null the path starts with the root. Otherwise the StartUri marks the path item where to start. StartUri must be a sub path of the StartUri.

Parameters:

startUri - The new StartUri value

setRootName

public void setRootName(String rootName)

Changes the name of the virtual root ("/").

Parameters:

rootName - The new RootName value

setController

public void setController(com.sapportals.wdf.stack.Control controller)

Controller which is responsible to handle click event.

Parameters:

controller - The new Controller value

setHandler

public void setHandler(String handler)

Handler which is responsible to handle click event.

Parameters:

handler - The new Handler value

getDifferential

public String getDifferential()

Get the Differential attribute of the ResourcePathControl2 object.

Returns:

- The Differential value

getImageVisible

public boolean getImageVisible()

Get the imageVisible attribute of the ResourcePathControl2 object.

Returns:

- The imageVisible value

isVirtualRootMode

public boolean isVirtualRootMode()

Get the ListMode attribute of the ResourcePathControl2 object.

Returns:

The VirtualRootMode value

getPathUri

public String getPathUri()

Get the Uri attribute of the ResourcePathControl2 object.

Returns:

The Uri value

isLastItemClickable

public boolean isLastItemClickable()

Get the LastItemClickable attribute of the ResourcePathControl2 object.

Returns:

The LastItemClickable value

isItemsClickable

public boolean isItemsClickable()

Get the ItemsClickable attribute of the ResourcePathControl2 object.

Returns:

The ItemsClickable value

getStartUri

public String getStartUri()

Get the StartUri attribute of the ResourcePathControl2 object.

Returns:

The StartUri value

getRootName

public String getRootName()

Get the RootName attribute of the ResourcePathControl2 object.

Returns:

The RootName value

getController

public com.sapportals.wdf.stack.Control getController()

Get the Controller attribute of the ResourcePathControl2 object.

Returns:

The Controller value

getHandler

public String getHandler()

Get the Handler attribute of the ResourcePathControl2 object.

Returns:

The Handler value

render

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

Renders RID as path.

Specified by:

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

Returns:

rendered HTMLB Component

Throws:

com.sapportals.wdf.WdfException - Exception raised in failure situation

Precondition: Class properties must be valid.

onDefaultClick

public com.sapportals.wdf.event.WdfEvent onDefaultClick(com.sapportals.htmlb.event.Event event)

Default onClick Handler. Sends the selected uri as an WdfEvent.

Parameters:

event - HTMLB event

Returns:

WDF event.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM