com.sapportals.wcm.control.edit

Class ResourcePropertiesControl

java.lang.Object
  com.sapportals.wdf.stack.Control
      com.sapportals.wcm.control.base.WcmBaseControl
          com.sapportals.wcm.control.base.WcmResourceControl
              com.sapportals.wcm.control.edit.ResourcePropertiesControl

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

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

Composite control which is responsible to render Copyright (c) SAP Portals Europe GmbH 2001

Nested Class Summary

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

WcmResourceControl.ResourceNotFoundException

Field Summary

protected static String	EVENT_ON_TOGGLE_TABSTRIP
boolean	newCollection
boolean	propertiesForUpload
String	resourceMimetype
String[]	resourceTypes

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

ResourcePropertiesControl()

Method Summary

boolean	canSave() Workaround for composite control usage.
com.sapportals.wdf.event.WdfEvent	checkMandatoryProperties() Description of the Method
void	create(com.sapportals.wdf.stack.ControlContext cc) Description of the Method
protected void	createNestedControls() Register composite parts
List	getAllProperties() Retrieves all properties created for the resource
boolean	getDebug() Gets the debug attribute of the ResourcePropertyControl object
com.sapportals.htmlb.Component	getExternalComponent() Gets the externalComponent attribute of the ResourcePropertiesControl object
boolean	getHideIdFlag() Gets the hideIdFlag attribute of the ResourcePropertiesControl object
boolean	getIdMandatoryFlag() Gets the idMandatoryFlag attribute of the ResourcePropertiesControl object
String	getName() Gets the name attribute of the ResourcePropertiesControl object
boolean	getNameDisableFlag() Gets the nameDisableFlag attribute of the ResourcePropertiesControl object
boolean	getNameInvalidFlag() Gets the nameInvalidFlag attribute of the ResourcePropertiesControl object
boolean	getNewCollection() Gets the newCollection attribute of the ResourcePropertiesControl object
boolean	getNewResourceFlag() Gets the newResourceFlag attribute of the ResourcePropertiesControl object
String	getPersistsPropertiesKey() Gets the persistsPropertiesKey attribute of the ResourcePropertiesControl object
boolean	getPropertiesForUpload() Gets the propertiesForUpload attribute of the ResourcePropertiesControl object
IProperty	getProperty(IPropertyName propertyName) Retrieve a property from the property list
IPropertyMap	getPropertyMap() Retrieve all properties created for the resource
String	getResourceMimetype() Gets the resourceMimetype attribute of the ResourcePropertiesControl object
String[]	getResourceTypes() Gets the resourceTypes attribute of the ResourcePropertiesControl object
int	getSelectedTab() Gets the selectedTab attribute of the ResourcePropertiesControl object
boolean	getSendBackEvent() Gets the sendBackEvent attribute of the ResourcePropertiesControl object
boolean	getShowProperties() Gets the showProperties attribute of the ResourcePropertiesControl object
boolean	getShowPropertiesLink() Gets the showPropertiesLink attribute of the ResourcePropertiesControl object
boolean	getShowSaveButton() Get the ShowSaveButton attribute of the ResourceCustomPropertyControl2 object.
boolean	getUiDetailsHeader() Gets the uiDetailsHeader attribute of the ResourcePropertiesControl object
boolean	getUpdateProperties() Gets the updateProperties attribute of the ResourcePropertiesControl object
protected void	initialize() Initialize control by making a copy of data from resource.
protected boolean	isAccessibleImpl()
com.sapportals.wdf.event.WdfEvent	onAddNewValue(com.sapportals.htmlb.event.Event event) Adds a new empty component for a multi-valued property
com.sapportals.wdf.event.WdfEvent	onCancel(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onEditHtml(com.sapportals.htmlb.event.Event event) Renders the Html editor for a HTML metyproperty type
com.sapportals.wdf.event.WdfEvent	onSaveProperties(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onSetProperties(com.sapportals.htmlb.event.Event event) Description of the Method
void	onToggleTabStrip(com.sapportals.htmlb.event.Event event) Changes the group tab
com.sapportals.wdf.event.WdfEvent	processCommandException(Command command) Description of the Method
protected void	readInputData()
void	receive(com.sapportals.wdf.event.WdfEvent wdfEvent) Description of the Method
com.sapportals.htmlb.Component	render() Return the GridLayout that contains all the controls sub controls.
com.sapportals.htmlb.Component	renderBaseProperties(boolean isResourceLockedByOther) Render ID, Name & Description fields
protected com.sapportals.htmlb.Component	renderCustomProperties() Render Custom group
com.sapportals.htmlb.Component	renderPersistentProperties() Renders local properties map as hidden InputField.
com.sapportals.htmlb.Component	renderPropertiesTabs() Renders the group tabs
void	restorePersistentProperties(com.sapportals.htmlb.page.DynPage page) Restores local properties map as hidden InputField.
com.sapportals.wdf.event.WdfEvent	saveAllProperties(com.sapportals.htmlb.event.Event event) Description of the Method
void	setDebug(boolean debug) Sets the debug attribute of the ResourcePropertyControl object
void	setEmptyProperties() Empty the properties list
void	setExternalComponent(com.sapportals.htmlb.Component uiDetails) Sets the externalComponent attribute of the ResourcePropertiesControl object
void	setHideIdFlag(boolean flag) Sets the hideIdFlag attribute of the ResourcePropertiesControl object
void	setIdMandatoryFlag(boolean flag) Sets the idMandatoryFlag attribute of the ResourcePropertiesControl object
void	setName(String displayName) Sets the name attribute of the ResourcePropertiesControl object
void	setNameDisableFlag(boolean flag) Sets the nameDisableFlag attribute of the ResourcePropertiesControl object
void	setNameInvalidFlag(boolean flag) Sets the nameInvalidFlag attribute of the ResourcePropertiesControl object
void	setNewCollection(boolean flag) Sets the newCollection attribute of the ResourcePropertiesControl object
void	setNewResourceFlag(boolean flag) Sets the newResourceFlag attribute of the ResourcePropertiesControl object
void	setPersistsPropertiesKey(String persistsPropertiesKeyValue) Sets the persistsPropertiesKey attribute of the ResourcePropertiesControl object
void	setPropertiesForUpload(boolean flag) Sets the propertiesForUpload attribute of the ResourcePropertiesControl object
void	setResourceMimetype(String mimetype) Sets the resourceMimetype attribute of the ResourcePropertiesControl object
void	setResourceTypes(String[] newResourceTypes) Sets the resourceTypes attribute of the ResourcePropertiesControl object
void	setSelectedTab(int flag) Sets the selectedTab attribute of the ResourcePropertiesControl object
void	setSendBackEvent(boolean flag) Sets the sendBackEvent attribute of the ResourcePropertiesControl object
void	setShowProperties(boolean flag) Sets the showProperties attribute of the ResourcePropertiesControl object
void	setShowPropertiesLink(boolean flag) Sets the showPropertiesLink attribute of the ResourcePropertiesControl object
void	setShowSaveButton(boolean showSaveButton) Set the ShowSaveButton attribute of the ResourceCustomPropertyControl2 object.
void	setUiDetailsHeader(boolean uiDetails) Sets the uiDetailsHeader attribute of the ResourcePropertiesControl object
void	setUpdateProperties(boolean flag) Sets the updateProperties attribute of the ResourcePropertiesControl object
void	setUri(String uri) Sets the uri attribute of the ResourcePropertiesControl object

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

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

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, setControlContext, setResourceContext, setTestMode, setVisible

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

create, createUnequivocallyComponentId, dispatchHtmlbEvent, dispatchWdfEvent, getControlContext, getDynPage, getID, getParent, getPersistenceComponentManager, getRootControl, getStackId, initializeImpl, isInitialized, register, 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

EVENT_ON_TOGGLE_TABSTRIP

protected static final String EVENT_ON_TOGGLE_TABSTRIP

See Also:

Constant Field Values

newCollection

public boolean newCollection

resourceMimetype

public String resourceMimetype

resourceTypes

public String[] resourceTypes

propertiesForUpload

public boolean propertiesForUpload

Constructor Detail

ResourcePropertiesControl

public ResourcePropertiesControl()

Method Detail

setUri

public void setUri(String uri)

Sets the uri attribute of the ResourcePropertiesControl object

Overrides:

setUri in class WcmResourceControl

Parameters:

uri - The new uri value

setDebug

public void setDebug(boolean debug)

Sets the debug attribute of the ResourcePropertyControl object

Parameters:

debug - The new debug value

getDebug

public boolean getDebug()

Gets the debug attribute of the ResourcePropertyControl object

Returns:

The debug value

setShowProperties

public void setShowProperties(boolean flag)

Sets the showProperties attribute of the ResourcePropertiesControl object

Parameters:

flag - The new showProperties value

getShowProperties

public boolean getShowProperties()

Gets the showProperties attribute of the ResourcePropertiesControl object

Returns:

The showProperties value

setShowPropertiesLink

public void setShowPropertiesLink(boolean flag)

Sets the showPropertiesLink attribute of the ResourcePropertiesControl object

Parameters:

flag - The new showPropertiesLink value

getShowPropertiesLink

public boolean getShowPropertiesLink()

Gets the showPropertiesLink attribute of the ResourcePropertiesControl object

Returns:

The showPropertiesLink value

setPersistsPropertiesKey

public void setPersistsPropertiesKey(String persistsPropertiesKeyValue)

Sets the persistsPropertiesKey attribute of the ResourcePropertiesControl object

Parameters:

persistsPropertiesKeyValue - The new persistsPropertiesKey value

getPersistsPropertiesKey

public String getPersistsPropertiesKey()

Gets the persistsPropertiesKey attribute of the ResourcePropertiesControl object

Returns:

The persistsPropertiesKey value

setSendBackEvent

public void setSendBackEvent(boolean flag)

Sets the sendBackEvent attribute of the ResourcePropertiesControl object

Parameters:

flag - The new sendBackEvent value

getSendBackEvent

public boolean getSendBackEvent()

Gets the sendBackEvent attribute of the ResourcePropertiesControl object

Returns:

The sendBackEvent value

setUpdateProperties

public void setUpdateProperties(boolean flag)

Sets the updateProperties attribute of the ResourcePropertiesControl object

Parameters:

flag - The new updateProperties value

getUpdateProperties

public boolean getUpdateProperties()

Gets the updateProperties attribute of the ResourcePropertiesControl object

Returns:

The updateProperties value

setNameInvalidFlag

public void setNameInvalidFlag(boolean flag)

Sets the nameInvalidFlag attribute of the ResourcePropertiesControl object

Parameters:

flag - The new nameInvalidFlag value

getNameInvalidFlag

public boolean getNameInvalidFlag()

Gets the nameInvalidFlag attribute of the ResourcePropertiesControl object

Returns:

The nameInvalidFlag value

setIdMandatoryFlag

public void setIdMandatoryFlag(boolean flag)

Sets the idMandatoryFlag attribute of the ResourcePropertiesControl object

Parameters:

flag - The new idMandatoryFlag value

getIdMandatoryFlag

public boolean getIdMandatoryFlag()

Gets the idMandatoryFlag attribute of the ResourcePropertiesControl object

Returns:

The idMandatoryFlag value

setHideIdFlag

public void setHideIdFlag(boolean flag)

Sets the hideIdFlag attribute of the ResourcePropertiesControl object

Parameters:

flag - The new hideIdFlag value

getHideIdFlag

public boolean getHideIdFlag()

Gets the hideIdFlag attribute of the ResourcePropertiesControl object

Returns:

The hideIdFlag value

setNameDisableFlag

public void setNameDisableFlag(boolean flag)

Sets the nameDisableFlag attribute of the ResourcePropertiesControl object

Parameters:

flag - The new nameDisableFlag value

getNameDisableFlag

public boolean getNameDisableFlag()

Gets the nameDisableFlag attribute of the ResourcePropertiesControl object

Returns:

The nameDisableFlag value

setShowSaveButton

public void setShowSaveButton(boolean showSaveButton)

Set the ShowSaveButton attribute of the ResourceCustomPropertyControl2 object.

Parameters:

showSaveButton - The new ShowSaveButton value

getShowSaveButton

public boolean getShowSaveButton()

Get the ShowSaveButton attribute of the ResourceCustomPropertyControl2 object.

Returns:

The ShowSaveButton value

setNewResourceFlag

public void setNewResourceFlag(boolean flag)

Sets the newResourceFlag attribute of the ResourcePropertiesControl object

Parameters:

flag - The new newResourceFlag value

getNewResourceFlag

public boolean getNewResourceFlag()

Gets the newResourceFlag attribute of the ResourcePropertiesControl object

Returns:

The newResourceFlag value

setNewCollection

public void setNewCollection(boolean flag)

Sets the newCollection attribute of the ResourcePropertiesControl object

Parameters:

flag - The new newCollection value

getNewCollection

public boolean getNewCollection()

Gets the newCollection attribute of the ResourcePropertiesControl object

Returns:

The newCollection value

setResourceMimetype

public void setResourceMimetype(String mimetype)

Sets the resourceMimetype attribute of the ResourcePropertiesControl object

Parameters:

mimetype - The new resourceMimetype value

getResourceMimetype

public String getResourceMimetype()

Gets the resourceMimetype attribute of the ResourcePropertiesControl object

Returns:

The resourceMimetype value

setResourceTypes

public void setResourceTypes(String[] newResourceTypes)

Sets the resourceTypes attribute of the ResourcePropertiesControl object

Parameters:

newResourceTypes - The new resourceTypes value

getResourceTypes

public String[] getResourceTypes()

Gets the resourceTypes attribute of the ResourcePropertiesControl object

Returns:

The resourceTypes value

setPropertiesForUpload

public void setPropertiesForUpload(boolean flag)

Sets the propertiesForUpload attribute of the ResourcePropertiesControl object

Parameters:

flag - The new propertiesForUpload value

getPropertiesForUpload

public boolean getPropertiesForUpload()

Gets the propertiesForUpload attribute of the ResourcePropertiesControl object

Returns:

The propertiesForUpload value

setSelectedTab

public void setSelectedTab(int flag)

Sets the selectedTab attribute of the ResourcePropertiesControl object

Parameters:

flag - The new selectedTab value

getSelectedTab

public int getSelectedTab()

Gets the selectedTab attribute of the ResourcePropertiesControl object

Returns:

The selectedTab value

setUiDetailsHeader

public void setUiDetailsHeader(boolean uiDetails)

Sets the uiDetailsHeader attribute of the ResourcePropertiesControl object

Parameters:

uiDetails - The new uiDetailsHeader value

getUiDetailsHeader

public boolean getUiDetailsHeader()

Gets the uiDetailsHeader attribute of the ResourcePropertiesControl object

Returns:

The uiDetailsHeader value

setExternalComponent

public void setExternalComponent(com.sapportals.htmlb.Component uiDetails)

Sets the externalComponent attribute of the ResourcePropertiesControl object

Parameters:

uiDetails - The new externalComponent value

getExternalComponent

public com.sapportals.htmlb.Component getExternalComponent()

Gets the externalComponent attribute of the ResourcePropertiesControl object

Returns:

The externalComponent value

setName

public void setName(String displayName)

Sets the name attribute of the ResourcePropertiesControl object

Parameters:

displayName - The new name value

getName

public String getName()

Gets the name attribute of the ResourcePropertiesControl object

Returns:

The name value

canSave

public boolean canSave()
                throws WcmException,
                       com.sapportals.wdf.WdfException

Workaround for composite control usage.

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

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

createNestedControls

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

Register composite parts

Overrides:

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

Throws:

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

create

public void create(com.sapportals.wdf.stack.ControlContext cc)
            throws com.sapportals.wdf.WdfException

Description of the Method

Overrides:

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

Parameters:

cc - Description of the param

Throws:

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

render

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

Return the GridLayout that contains all the controls sub controls. Needs to be implemented by the derivced control class.

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

<{WcmException}>

renderBaseProperties

public com.sapportals.htmlb.Component renderBaseProperties(boolean isResourceLockedByOther)
                                                    throws WcmException

Render ID, Name & Description fields

Parameters:

isResourceLockedByOther - Description of the param

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

receive

public void receive(com.sapportals.wdf.event.WdfEvent wdfEvent)
             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:

wdfEvent - Description of the param

Throws:

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

onSetProperties

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

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

onSaveProperties

public com.sapportals.wdf.event.WdfEvent onSaveProperties(com.sapportals.htmlb.event.Event event)
                                                   throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

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

saveAllProperties

public com.sapportals.wdf.event.WdfEvent saveAllProperties(com.sapportals.htmlb.event.Event event)
                                                    throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

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

onCancel

public com.sapportals.wdf.event.WdfEvent onCancel(com.sapportals.htmlb.event.Event event)
                                           throws ResourceException

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

ResourceException - Exception raised in failure situation

onToggleTabStrip

public void onToggleTabStrip(com.sapportals.htmlb.event.Event event)
                      throws com.sapportals.wdf.WdfException

Changes the group tab

Parameters:

event - Description of the param

Throws:

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

onAddNewValue

public com.sapportals.wdf.event.WdfEvent onAddNewValue(com.sapportals.htmlb.event.Event event)
                                                throws com.sapportals.wdf.WdfException

Adds a new empty component for a multi-valued property

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

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

onEditHtml

public com.sapportals.wdf.event.WdfEvent onEditHtml(com.sapportals.htmlb.event.Event event)
                                             throws com.sapportals.wdf.WdfException

Renders the Html editor for a HTML metyproperty type

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

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

renderPropertiesTabs

public com.sapportals.htmlb.Component renderPropertiesTabs()
                                                    throws WcmException

Renders the group tabs

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

renderCustomProperties

protected com.sapportals.htmlb.Component renderCustomProperties()
                                                         throws WcmException

Render Custom group

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

readInputData

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

Overrides:

readInputData in class WcmBaseControl

Throws:

com.sapportals.wdf.WdfException

initialize

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

Initialize control by making a copy of data from resource.

Overrides:

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

Throws:

com.sapportals.wdf.WdfException

restorePersistentProperties

public void restorePersistentProperties(com.sapportals.htmlb.page.DynPage page)
                                 throws com.sapportals.wdf.WdfException

Restores local properties map as hidden InputField.

Overrides:

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

Parameters:

page - The DynPage to read out components

Throws:

com.sapportals.wdf.WdfException

renderPersistentProperties

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

Renders local properties map as hidden InputField.

Overrides:

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

Returns:

A sub control tree containing hidden fields.

Throws:

com.sapportals.wdf.WdfException

isAccessibleImpl

protected boolean isAccessibleImpl()
                            throws WcmException

Throws:

WcmException

getAllProperties

public List getAllProperties()

Retrieves all properties created for the resource

Returns:

The allProperties value

getProperty

public IProperty getProperty(IPropertyName propertyName)

Retrieve a property from the property list

Parameters:

propertyName - Description of the Parameter

Returns:

The allProperties value

setEmptyProperties

public void setEmptyProperties()

Empty the properties list

checkMandatoryProperties

public com.sapportals.wdf.event.WdfEvent checkMandatoryProperties()

Description of the Method

Returns:

Description of the Return Value

getPropertyMap

public IPropertyMap getPropertyMap()

Retrieve all properties created for the resource

Returns:

The allProperties value

processCommandException

public com.sapportals.wdf.event.WdfEvent processCommandException(Command command)

Description of the Method

Parameters:

command - Description of the param

Returns:

Description of the Return Value

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