com.sapportals.wcm.control.navigation

Class ResourcePreviewControl

java.lang.Object
  extended by com.sapportals.wdf.stack.Control
      extended by com.sapportals.wcm.control.base.WcmBaseControl
          extended by com.sapportals.wcm.control.base.WcmResourceControl
              extended by com.sapportals.wcm.control.navigation.ResourcePreviewControl
All Implemented Interfaces:
IPreview, IPublicControl, com.sapportals.wdf.event.WdfEventReceiver

public class ResourcePreviewControl
extends WcmResourceControl
implements com.sapportals.wdf.event.WdfEventReceiver, IPublicControl, IPreview

The control is only available for folder and only if the properties service is assigned to the corresponding repository.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.sapportals.wcm.control.base.WcmResourceControl
WcmResourceControl.ResourceNotFoundException
 
Field Summary
 
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
ResourcePreviewControl()
          Constructor for the DemoPreviewControl object
 
Method Summary
 boolean canRender()
           
 com.sapportals.wdf.stack.Control getNewInstance()
           
 boolean getShowResourceTile()
          Gets the showResourceTile attribute of the ResourcePreviewControl
 void receive(com.sapportals.wdf.event.WdfEvent recEvent)
          Description of the Method
 com.sapportals.htmlb.Component render()
          Description of the Method
 void setPreviewResource(IResource previewRes)
           
 void setShowResourceTile(boolean impEnhanced)
          Sets if the Preview resource displayname will be displayed in the Group title
 
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, 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

ResourcePreviewControl

public ResourcePreviewControl()
Constructor for the DemoPreviewControl object

Method Detail

getNewInstance

public com.sapportals.wdf.stack.Control getNewInstance()
Specified by:
getNewInstance in interface IPublicControl

setShowResourceTile

public void setShowResourceTile(boolean impEnhanced)
Sets if the Preview resource displayname will be displayed in the Group title

Specified by:
setShowResourceTile in interface IPreview
Parameters:
impEnhanced - The new showResourceTile value

getShowResourceTile

public boolean getShowResourceTile()
                            throws ResourceException
Gets the showResourceTile attribute of the ResourcePreviewControl

Returns:
The showResourceTile value
Throws:
ResourceException - Exception raised in failure situation

render

public com.sapportals.htmlb.Component render()
                                      throws com.sapportals.wdf.WdfException
Description of the Method

Specified by:
render in class com.sapportals.wdf.stack.Control
Returns:
Description of the Return Value
Throws:
com.sapportals.wdf.WdfException - Exception raised in failure situation

receive

public void receive(com.sapportals.wdf.event.WdfEvent recEvent)
             throws com.sapportals.wdf.WdfException
Description of the Method

Specified by:
receive in interface com.sapportals.wdf.event.WdfEventReceiver
Overrides:
receive in class WcmResourceControl
Parameters:
recEvent - Description of the param
Throws:
com.sapportals.wdf.WdfException - Exception raised in failure situation

setPreviewResource

public void setPreviewResource(IResource previewRes)
Specified by:
setPreviewResource in interface IPreview

canRender

public boolean canRender()
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


Copyright 2014 SAP AG Complete Copyright Notice