com.sapportals.wcm.control.navigation

Class TaxonomyControl

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.TaxonomyControl
All Implemented Interfaces:
com.sapportals.wdf.event.WdfEventReceiver

public class TaxonomyControl
extends WcmResourceControl
implements com.sapportals.wdf.event.WdfEventReceiver

Describe here.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.sapportals.wcm.control.base.WcmResourceControl
WcmResourceControl.ResourceNotFoundException
 
Field Summary
static String SEP_SLASH
           
 
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
TaxonomyControl()
           
 
Method Summary
protected  void createNestedControls()
          Create, parameterize and register nested controls.
 int getColumn()
           
 String getControlPersistence()
           
 String getPersistentCheckBoxStates()
           
 String getPersistentCheckBoxURLs()
           
 String getRootUriName()
           
 String getRootUris()
           
 IRidList getRootUrisAsList()
           
 int getRow()
           
 boolean getShowControlPersistence()
           
 boolean getShowFilesAndFolders()
           
 int getStartItem()
           
 String getStartUri()
           
 boolean isEnableDisplayNames()
           
 boolean isInClassificationMode()
           
 boolean isInIndexFolderMode()
           
 boolean isShowFullDescription()
           
 boolean isShowPath()
           
 com.sapportals.wdf.event.WdfEvent onCategoriesSelected(com.sapportals.htmlb.event.Event event)
          Called by surrounding composite control.
 com.sapportals.wdf.event.WdfEvent onControlPersistence(com.sapportals.htmlb.event.Event event)
           
 com.sapportals.wdf.event.WdfEvent onFolderClick(com.sapportals.htmlb.event.Event event)
           
 com.sapportals.wdf.event.WdfEvent onHeaderAction(com.sapportals.htmlb.event.Event event)
           
 com.sapportals.wdf.event.WdfEvent onPage(com.sapportals.htmlb.event.Event event)
           
 com.sapportals.wdf.event.WdfEvent onPathClick(com.sapportals.htmlb.event.Event event)
           
 com.sapportals.wdf.event.WdfEvent onResourceAction(com.sapportals.htmlb.event.Event event)
           
 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 restorePersistentProperties(com.sapportals.htmlb.page.DynPage requestDocument)
           
 void setColumn(int column)
           
 void setControlPersistence(String controlPersistence)
           
 void setEnableDisplayNames(boolean value)
           
 void setInClassificationMode(boolean inClassificationMode)
           
 void setInIndexFolderMode(boolean inIndexFolderMode)
           
 void setPersistentCheckBoxStates(String value)
           
 void setPersistentCheckBoxURLs(String value)
           
 void setRootUriName(String rootUriName)
           
 void setRootUris(String rootUris)
           
 void setRow(int row)
           
 void setShowControlPersistence(boolean value)
           
 void setShowFilesAndFolders(boolean showFilesAndFolders)
           
 void setShowFullDescription(boolean showFullDescription)
           
 void setShowPath(boolean showPath)
           
 void setStartItem(int startItem)
           
 void setStartUri(String startUri)
           
 
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, 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

SEP_SLASH

public static final String SEP_SLASH
See Also:
Constant Field Values
Constructor Detail

TaxonomyControl

public TaxonomyControl()
Method Detail

isShowPath

public boolean isShowPath()

setShowPath

public void setShowPath(boolean showPath)

isInClassificationMode

public boolean isInClassificationMode()

setInClassificationMode

public void setInClassificationMode(boolean inClassificationMode)

isInIndexFolderMode

public boolean isInIndexFolderMode()

setInIndexFolderMode

public void setInIndexFolderMode(boolean inIndexFolderMode)

setPersistentCheckBoxURLs

public void setPersistentCheckBoxURLs(String value)

getPersistentCheckBoxURLs

public String getPersistentCheckBoxURLs()

setPersistentCheckBoxStates

public void setPersistentCheckBoxStates(String value)

getPersistentCheckBoxStates

public String getPersistentCheckBoxStates()

getColumn

public int getColumn()

setColumn

public void setColumn(int column)

getRow

public int getRow()

setRow

public void setRow(int row)

getShowControlPersistence

public boolean getShowControlPersistence()

setShowControlPersistence

public void setShowControlPersistence(boolean value)

getControlPersistence

public String getControlPersistence()

setControlPersistence

public void setControlPersistence(String controlPersistence)

setEnableDisplayNames

public void setEnableDisplayNames(boolean value)

isEnableDisplayNames

public boolean isEnableDisplayNames()

getStartUri

public String getStartUri()

setStartUri

public void setStartUri(String startUri)

getStartItem

public int getStartItem()

setStartItem

public void setStartItem(int startItem)

setShowFilesAndFolders

public void setShowFilesAndFolders(boolean showFilesAndFolders)

getShowFilesAndFolders

public boolean getShowFilesAndFolders()

setRootUris

public void setRootUris(String rootUris)

getRootUris

public String getRootUris()

getRootUrisAsList

public IRidList getRootUrisAsList()

getRootUriName

public String getRootUriName()

setRootUriName

public void setRootUriName(String rootUriName)

isShowFullDescription

public boolean isShowFullDescription()

setShowFullDescription

public void setShowFullDescription(boolean showFullDescription)

restorePersistentProperties

public void restorePersistentProperties(com.sapportals.htmlb.page.DynPage requestDocument)
                                 throws com.sapportals.wdf.WdfException
Overrides:
restorePersistentProperties in class com.sapportals.wdf.stack.Control
Throws:
com.sapportals.wdf.WdfException

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

onPage

public com.sapportals.wdf.event.WdfEvent onPage(com.sapportals.htmlb.event.Event event)
                                         throws ResourceException
Throws:
ResourceException

onPathClick

public com.sapportals.wdf.event.WdfEvent onPathClick(com.sapportals.htmlb.event.Event event)
                                              throws WcmException
Throws:
WcmException

onFolderClick

public com.sapportals.wdf.event.WdfEvent onFolderClick(com.sapportals.htmlb.event.Event event)
                                                throws WcmException
Throws:
WcmException

onResourceAction

public com.sapportals.wdf.event.WdfEvent onResourceAction(com.sapportals.htmlb.event.Event event)
                                                   throws WcmException
Throws:
WcmException

onControlPersistence

public com.sapportals.wdf.event.WdfEvent onControlPersistence(com.sapportals.htmlb.event.Event event)
                                                       throws WcmException,
                                                              com.sapportals.wdf.WdfException
Throws:
WcmException
com.sapportals.wdf.WdfException

onCategoriesSelected

public com.sapportals.wdf.event.WdfEvent onCategoriesSelected(com.sapportals.htmlb.event.Event event)
                                                       throws WcmException
Called by surrounding composite control.

Throws:
WcmException

onHeaderAction

public com.sapportals.wdf.event.WdfEvent onHeaderAction(com.sapportals.htmlb.event.Event event)
                                                 throws WcmException
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
Throws:
com.sapportals.wdf.WdfException

createNestedControls

protected void createNestedControls()
                             throws com.sapportals.wdf.WdfException
Create, parameterize and register nested controls.

Overrides:
createNestedControls in class com.sapportals.wdf.stack.Control
Throws:
com.sapportals.wdf.WdfException
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