com.sapportals.wcm.control.edit

Class PropertiesControl

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.PropertiesControl

All Implemented Interfaces:

IPropertyStructureRenderer, IPublicControl, IContentEditable, IEditableProperty, IItemtypeRenderer, IShowProperties, IStartUriRenderer, IPropertyRendererProxy, com.sapportals.wdf.event.WdfEventReceiver

public class PropertiesControl
extends WcmResourceControl
implements com.sapportals.wdf.event.WdfEventReceiver, IPropertyRendererProxy, IPublicControl, IPropertyStructureRenderer, IEditableProperty, IContentEditable, IShowProperties, IItemtypeRenderer, IStartUriRenderer

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

static String	CID_PROPERTY_VALUE
protected static String	EVENT_ON_TOGGLE_TABSTRIP
boolean	multipleUploadRendering
boolean	newCollection
static String	ON_DELEGATE_EVENT
boolean	propertiesForUpload
String	resourceMimetype
String	resourceType
static String	SHOW_LINK_STRUCTURE_PROPERTIES
boolean	uploadRendering

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

Fields inherited from interface com.sapportals.wcm.service.propertyconfig.IPropertyRendererProxy

DEPENDENCE_EVENT, DISPATCH_EVENT

Fields inherited from interface com.sapportals.wcm.control.util.IContentEditable

HTML_TYPE, TEXT_TYPE, UPLOAD_TYPE

Constructor Summary

PropertiesControl()

Method Summary

void	addInitialProperties(IPropertyMap initialProperties)
boolean	allowSetProprties() Checks if SetProperties is allowed to be done by the Properties dialog
com.sapportals.wdf.event.WdfEvent	checkMandatoryProperties() Description of the Method
com.sapportals.wdf.event.WdfEvent	checkPropertiesValidation() This method is looking for properties validation First is looking if the properties are semantic corectly ( Date , Time & Timestamp) Second is looking for the Standart validation Third is calling the properties validation class
ArrayList	decodeValues(com.sapportals.htmlb.event.Event event) Returns the values created via the dispatchableControlIDWithValues or dispatchableControlID methods and returns the list of parameters in the same order they were when submitting them.
String	dispatchableControlID(String value) Adds a string to the given parameter to ensure a unique id within a DynPage under certain conditions: the idpart given is unique within this proxy.
String	dispatchableControlIDWithValues(ArrayList values) Create an id that contains dispatch information.
Map	getAdditionalInformation()
Map	getAdditionalInformation(boolean usedIMetaContext)
List	getAllProperties() Retrieves all properties created for the resource
String	getContentType()
IPropertyMap	getDefaultPropertyMap() Returns the default properties for the current property structure
com.sapportals.htmlb.Component	getExternalComponent() Gets the externalComponent attribute of the ResourcePropertiesControl object
com.sapportals.htmlb.Component	getExternalLabelComponent() Gets the externalLabelComponent attribute of the ResourcePropertiesControl object
String	getGroupTitleBundle()
String	getGroupTitleKey()
String	getHidden()
boolean	getHideIdFlag() Gets the hideIdFlag attribute of the ResourcePropertiesControl object
boolean	getIdMandatoryFlag() Gets the idMandatoryFlag attribute of the ResourcePropertiesControl object
boolean	getInvisibleID()
String	getLastUserSelection() Gets the name attribute of the ResourcePropertiesControl object
String	getMaintainable()
String	getMessageBundleKey()
boolean	getMultipleUploadRendering() Used only for Multiple Upload Dialog, for rendering the properties according to multiple upload scenario
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
com.sapportals.wdf.stack.Control	getNewInstance()
boolean	getNewResourceFlag() Gets the newResourceFlag attribute of the ResourcePropertiesControl object
String	getPersistsPropertiesKey() Gets the persistsPropertiesKey attribute of the ResourcePropertiesControl object
String	getProperties()
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	getPropertyStructureName()
String	getPropertyStructureString()
String	getResourceMimetype() Gets the resourceMimetype attribute of the ResourcePropertiesControl object
String	getResourceType() 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	getShowHiddenProperty()
boolean	getShowPartialProperties() If the properties are rendered Partial ( Name & Description before Show Properties link)
boolean	getShowProperties() Gets the current status of the Show/Hide Properties link If it renturs true then the Hide Properties link is active ( visible for UI) and if it return false, Show Properties link is visible for UI
boolean	getShowPropertiesLink() Returns true/false depending is the Show/Hide Properties link in Properties dialog
boolean	getShowPropertiesLinkStatus() Gets the current status of the Show/Hide Properties link By creating properties for normal item this should return true otherwise false
boolean	getShowSaveButton() Get the ShowSaveButton attribute of the ResourceCustomPropertyControl2 object.
IStructuredGroupItemList	getSingleProperties()
IStructuredGroupItemList	getSinglePropertiesObject()
String	getStartUri() Retrieve the startURI
String	getStructureDisplayMode() Gets the property structure which will be displayed
String	getTabWidth()
boolean	getUiDetailsHeader() Gets the uiDetailsHeader attribute of the ResourcePropertiesControl object
String	getUniqueComponentId(IMetaName metaName, String key)
boolean	getUpdateProperties() Gets the updateProperties attribute of the ResourcePropertiesControl object
boolean	getUploadRendering() Used only for Upload Dialog, for rendering the FileUpload component after item Type property
protected void	initialize() Initialize control by making a copy of data from resource.
boolean	isContentEditable() Returns true if the content editable is supported or false otherwise
boolean	isContentRendered() Returns true if the content has been rendered or false otherwise
boolean	isIDEditable()
boolean	isItemTypeRendered() Returns true if the resourcetype property had been already rendered and false otherwise
boolean	isNameEditable()
boolean	isRenderAlwaysItemType() Returns true if the resourcetype property must be always rendered and false otherwise
boolean	isStandalone()
boolean	isUserControlRendered()
com.sapportals.wdf.event.WdfEvent	onCancel(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onDelegateEvent(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onRefresh(com.sapportals.htmlb.event.Event event)
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
com.sapportals.wdf.event.WdfEvent	processEvent(com.sapportals.htmlb.event.Event event, boolean callReadInput)
com.sapportals.wdf.event.WdfEvent	processException(Exception e, String message)
protected void	readInputData()
PropertiesArrayList	readSingleProperties(PropertiesArrayList cProperties, int fileIndex)
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	renderMetaNameLabelRequired(IMetaName metaName, IMetaContext rendererContext, boolean isRequired)
com.sapportals.htmlb.Component	renderPersistentProperties() Renders local properties map as hidden InputField.
com.sapportals.htmlb.Component	renderPropertiesTabs(List TabComponentList) Renders the group tabs
com.sapportals.htmlb.Component	renderSingleProperties(int fileIndex, PropertiesArrayList propertiesList)
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	setAdditionalInformation(Map additionalInformation)
void	setContentEditable(boolean contentEditable) Sets true if the content editable is supported or false otherwise
void	setContentRendered(boolean cr) Sets true if the content has been rendered or false otherwise
void	setContentType(String contentType) Sets the content type of the content.
void	setEmptyProperties() Empty the properties list
void	setExternalComponent(com.sapportals.htmlb.Component uiDetails) Sets the externalComponent attribute of the ResourcePropertiesControl object
void	setExternalLabelComponent(com.sapportals.htmlb.Component uiDetails) Sets the externalLabelComponent attribute of the ResourcePropertiesControl object
void	setGroupTitleBundle(String grpTitle)
void	setGroupTitleKey(String grpTitle)
void	setHidden(String properties)
void	setHideIdFlag(boolean flag) Sets the hideIdFlag attribute of the ResourcePropertiesControl object
void	setIDEditable(boolean flag)
void	setIdMandatoryFlag(boolean flag) Sets the idMandatoryFlag attribute of the ResourcePropertiesControl object
void	setInvisibleID(boolean flag)
void	setItemTypeRendered(boolean active) Sets true if resourcetype has been already rendered, and false otherwise
void	setLastUserSelection(String displayName) Sets the name attribute of the ResourcePropertiesControl object
void	setMaintainable(String properties)
void	setMessageBundleKey(String grpTitle)
void	setMultipleUploadRendering(boolean flag) If it's true, then properties are rendered according to multiple file upload scenario
void	setName(String displayName) Sets the name attribute of the ResourcePropertiesControl object
void	setName(String displayName, boolean force)
void	setNameDisableFlag(boolean flag) Sets the nameDisableFlag attribute of the ResourcePropertiesControl object
void	setNameEditable(boolean flag)
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	setProperties(String properties)
void	setPropertiesForUpload(boolean flag) Sets the propertiesForUpload attribute of the ResourcePropertiesControl object
void	setPropertyStructureName(String propertyStructureString)
void	setPropertyStructureString(String propertyStructureString) Sets the property structure which will be displayed
void	setRenderAlwaysItemType(boolean flag) Sets true if resourcetype must be always rendered and false otherwise
void	setResourceMimetype(String mimetype) Sets the resourceMimetype attribute of the ResourcePropertiesControl object
void	setResourceType(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	setShowHiddenProperty(boolean flag)
void	setShowPartialProperties(boolean flag) Sets true if the properties are partial rendered ( Name & Description before Show Properties link) and false if all appear after Show/Hide Properties link
void	setShowProperties(boolean flag) Sets the current properties status.
void	setShowPropertiesLink(boolean flag) Sets for Properties dialog if the Show/Hide Properties link should be rendered
void	setShowPropertiesLinkStatus(boolean flag) Sets the current status of the Show/Hide Properties link *
void	setShowSaveButton(boolean showSaveButton) Set the ShowSaveButton attribute of the ResourceCustomPropertyControl2 object.
void	setSingleProperties(IStructuredGroupItemList singleProperties)
void	setStandalone(boolean isStandalone)
void	setStartUri(String startUri) Set the startURI with a new value
void	setStructureDisplayMode(String structDisplayMode) Sets the property structure which will be displayed
void	setTabWidth(String width)
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	setUploadRendering(boolean flag) If it's true, then the FileUpload component is rendering after ItemType
void	setUri(String uri) Sets the uri attribute of the ResourcePropertiesControl object
void	setUserControlRendered(boolean isUserControlRendered)

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

SHOW_LINK_STRUCTURE_PROPERTIES

public static final String SHOW_LINK_STRUCTURE_PROPERTIES

See Also:

Constant Field Values

ON_DELEGATE_EVENT

public static final String ON_DELEGATE_EVENT

See Also:

Constant Field Values

CID_PROPERTY_VALUE

public static final String CID_PROPERTY_VALUE

See Also:

Constant Field Values

newCollection

public boolean newCollection

resourceMimetype

public String resourceMimetype

resourceType

public String resourceType

propertiesForUpload

public boolean propertiesForUpload

uploadRendering

public boolean uploadRendering

multipleUploadRendering

public boolean multipleUploadRendering

Constructor Detail

PropertiesControl

public PropertiesControl()

Method Detail

setContentEditable

public void setContentEditable(boolean contentEditable)

Description copied from interface: IContentEditable

Sets true if the content editable is supported or false otherwise

Specified by:

setContentEditable in interface IContentEditable

isContentEditable

public boolean isContentEditable()

Description copied from interface: IContentEditable

Returns true if the content editable is supported or false otherwise

Specified by:

isContentEditable in interface IContentEditable

setContentRendered

public void setContentRendered(boolean cr)

Description copied from interface: IContentEditable

Sets true if the content has been rendered or false otherwise

Specified by:

setContentRendered in interface IContentEditable

isContentRendered

public boolean isContentRendered()

Description copied from interface: IContentEditable

Returns true if the content has been rendered or false otherwise

Specified by:

isContentRendered in interface IContentEditable

getContentType

public String getContentType()

Specified by:

getContentType in interface IContentEditable

Returns:

the content type of the content. It could be IContentEditable.HTML_TYPE, IContentEditable.TEXT_TYPE or null

setContentType

public void setContentType(String contentType)

Description copied from interface: IContentEditable

Sets the content type of the content. It could be IContentEditable.HTML_TYPE, IContentEditable.TEXT_TYPE or null

Specified by:

setContentType in interface IContentEditable

setSingleProperties

public void setSingleProperties(IStructuredGroupItemList singleProperties)

getSinglePropertiesObject

public IStructuredGroupItemList getSinglePropertiesObject()

getTabWidth

public String getTabWidth()

Specified by:

getTabWidth in interface IShowProperties

setTabWidth

public void setTabWidth(String width)

Specified by:

setTabWidth in interface IShowProperties

isRenderAlwaysItemType

public boolean isRenderAlwaysItemType()

Description copied from interface: IItemtypeRenderer

Returns true if the resourcetype property must be always rendered and false otherwise

Specified by:

isRenderAlwaysItemType in interface IItemtypeRenderer

Returns:

true if the resourcetype property must be always rendered, false otherwise.

setRenderAlwaysItemType

public void setRenderAlwaysItemType(boolean flag)

Description copied from interface: IItemtypeRenderer

Sets true if resourcetype must be always rendered and false otherwise

Specified by:

setRenderAlwaysItemType in interface IItemtypeRenderer

setItemTypeRendered

public void setItemTypeRendered(boolean active)

Description copied from interface: IItemtypeRenderer

Sets true if resourcetype has been already rendered, and false otherwise

Specified by:

setItemTypeRendered in interface IItemtypeRenderer

isItemTypeRendered

public boolean isItemTypeRendered()

Description copied from interface: IItemtypeRenderer

Returns true if the resourcetype property had been already rendered and false otherwise

Specified by:

isItemTypeRendered in interface IItemtypeRenderer

Returns:

true if the resourcetype property had been already rendered, false otherwise.

setStandalone

public void setStandalone(boolean isStandalone)

Parameters:

isStandalone -

isStandalone

public boolean isStandalone()

Returns:

true for stand alone, false otherwise.

addInitialProperties

public void addInitialProperties(IPropertyMap initialProperties)

setShowHiddenProperty

public void setShowHiddenProperty(boolean flag)

getShowHiddenProperty

public boolean getShowHiddenProperty()

getShowPartialProperties

public boolean getShowPartialProperties()

Description copied from interface: IShowProperties

If the properties are rendered Partial ( Name & Description before Show Properties link)

Specified by:

getShowPartialProperties in interface IShowProperties

setShowPartialProperties

public void setShowPartialProperties(boolean flag)

Description copied from interface: IShowProperties

Sets true if the properties are partial rendered ( Name & Description before Show Properties link) and false if all appear after Show/Hide Properties link

Specified by:

setShowPartialProperties in interface IShowProperties

isIDEditable

public boolean isIDEditable()

Specified by:

isIDEditable in interface IEditableProperty

setIDEditable

public void setIDEditable(boolean flag)

Specified by:

setIDEditable in interface IEditableProperty

setGroupTitleKey

public void setGroupTitleKey(String grpTitle)

getGroupTitleKey

public String getGroupTitleKey()

setGroupTitleBundle

public void setGroupTitleBundle(String grpTitle)

getGroupTitleBundle

public String getGroupTitleBundle()

setMessageBundleKey

public void setMessageBundleKey(String grpTitle)

getMessageBundleKey

public String getMessageBundleKey()

isNameEditable

public boolean isNameEditable()

Specified by:

isNameEditable in interface IEditableProperty

setNameEditable

public void setNameEditable(boolean flag)

Specified by:

setNameEditable in interface IEditableProperty

getNewInstance

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

Specified by:

getNewInstance in interface IPublicControl

getUniqueComponentId

public String getUniqueComponentId(IMetaName metaName,
                                   String key)

Specified by:

getUniqueComponentId in interface IPropertyRendererProxy

dispatchableControlIDWithValues

public String dispatchableControlIDWithValues(ArrayList values)
                                       throws WcmException

Description copied from interface: IPropertyRendererProxy

Create an id that contains dispatch information.

Specified by:

dispatchableControlIDWithValues in interface IPropertyRendererProxy

Parameters:

values - A string array parameter that could be read inside the event handler with decodeValues() (might be null)

Returns:

String The dispatchableControlID, created by a control.

Throws:

WcmException - Exception raised in failure situation

dispatchableControlID

public String dispatchableControlID(String value)
                             throws WcmException

Description copied from interface: IPropertyRendererProxy

Adds a string to the given parameter to ensure a unique id within a DynPage under certain conditions:
the idpart given is unique within this proxy. This means, that no two elements that are rendered by any classes that are again rendered within this proxy must call this method with the same parameter. If several proxies are rendered within one DynPage, the page itself must ensure that the proxies are configured to create different strings to add to the given parameters. So, if Class A, rendered within proxy B calls this method, submitting String S1, the resulting String Unique1 must be different from the String Unique2, that is created when Class A, rendered within proxy C calls this method, submitting String S1

Specified by:

dispatchableControlID in interface IPropertyRendererProxy

Parameters:

value - must not be null.

Returns:

a String

Throws:

WcmException

decodeValues

public ArrayList decodeValues(com.sapportals.htmlb.event.Event event)
                       throws WcmException

Description copied from interface: IPropertyRendererProxy

Returns the values created via the dispatchableControlIDWithValues or dispatchableControlID methods and returns the list of parameters in the same order they were when submitting them. There will be no en- or decoding done to take care of special characters. If the dispatchableControlID(String, String) method is used, a List with only one entry will be returned.

Specified by:

decodeValues in interface IPropertyRendererProxy

Parameters:

event - The event that contains the encoded values.

Returns:

String (cardinality = 1)

Throws:

WcmException

setPropertyStructureName

public void setPropertyStructureName(String propertyStructureString)

getPropertyStructureName

public String getPropertyStructureName()

setPropertyStructureString

public void setPropertyStructureString(String propertyStructureString)

Description copied from interface: IPropertyStructureRenderer

Sets the property structure which will be displayed

Specified by:

setPropertyStructureString in interface IPropertyStructureRenderer

Parameters:

propertyStructureString - The new propertyStructureString value

getPropertyStructureString

public String getPropertyStructureString()

setStructureDisplayMode

public void setStructureDisplayMode(String structDisplayMode)

Sets the property structure which will be displayed

Specified by:

setStructureDisplayMode in interface IPropertyStructureRenderer

Parameters:

structDisplayMode - The new structureDisplayMode value

getStructureDisplayMode

public String getStructureDisplayMode()

Gets the property structure which will be displayed

Returns:

The debug value

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

getStartUri

public String getStartUri()

Retrieve the startURI

Specified by:

getStartUri in interface IStartUriRenderer

Returns:

- the value of startUri as String

setStartUri

public void setStartUri(String startUri)

Set the startURI with a new value

Specified by:

setStartUri in interface IStartUriRenderer

Parameters:

startUri - - new vakue of the startUri

setUserControlRendered

public void setUserControlRendered(boolean isUserControlRendered)

isUserControlRendered

public boolean isUserControlRendered()

setShowProperties

public void setShowProperties(boolean flag)

Description copied from interface: IShowProperties

Sets the current properties status. If the flag is flase then the Properties below to the Show/Hide Properties link will not be displayed If it's trus then all the properties will be displayed and also the Hide Properties link

Specified by:

setShowProperties in interface IShowProperties

getShowProperties

public boolean getShowProperties()

Description copied from interface: IShowProperties

Gets the current status of the Show/Hide Properties link If it renturs true then the Hide Properties link is active ( visible for UI) and if it return false, Show Properties link is visible for UI

Specified by:

getShowProperties in interface IShowProperties

setShowPropertiesLink

public void setShowPropertiesLink(boolean flag)

Description copied from interface: IShowProperties

Sets for Properties dialog if the Show/Hide Properties link should be rendered

Specified by:

setShowPropertiesLink in interface IShowProperties

getShowPropertiesLink

public boolean getShowPropertiesLink()

Description copied from interface: IShowProperties

Returns true/false depending is the Show/Hide Properties link in Properties dialog

Specified by:

getShowPropertiesLink in interface IShowProperties

setShowPropertiesLinkStatus

public void setShowPropertiesLinkStatus(boolean flag)

Description copied from interface: IShowProperties

Sets the current status of the Show/Hide Properties link *

Specified by:

setShowPropertiesLinkStatus in interface IShowProperties

getShowPropertiesLinkStatus

public boolean getShowPropertiesLinkStatus()

Description copied from interface: IShowProperties

Gets the current status of the Show/Hide Properties link By creating properties for normal item this should return true otherwise false

Specified by:

getShowPropertiesLinkStatus in interface IShowProperties

setPersistsPropertiesKey

public void setPersistsPropertiesKey(String persistsPropertiesKeyValue)

Description copied from interface: IShowProperties

Sets the persistsPropertiesKey attribute of the ResourcePropertiesControl object

Specified by:

setPersistsPropertiesKey in interface IShowProperties

Parameters:

persistsPropertiesKeyValue - The new persistsPropertiesKey value

getPersistsPropertiesKey

public String getPersistsPropertiesKey()

Description copied from interface: IShowProperties

Gets the persistsPropertiesKey attribute of the ResourcePropertiesControl object

Specified by:

getPersistsPropertiesKey in interface IShowProperties

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

setInvisibleID

public void setInvisibleID(boolean flag)

getInvisibleID

public boolean getInvisibleID()

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

setResourceType

public void setResourceType(String newResourceTypes)

Sets the resourceTypes attribute of the ResourcePropertiesControl object

Parameters:

newResourceTypes - The new resourceTypes value

getResourceType

public String getResourceType()

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

setUploadRendering

public void setUploadRendering(boolean flag)

If it's true, then the FileUpload component is rendering after ItemType

Parameters:

flag - The new propertiesForUpload value

getUploadRendering

public boolean getUploadRendering()

Used only for Upload Dialog, for rendering the FileUpload component after item Type property

Returns:

The propertiesForUpload value

setMultipleUploadRendering

public void setMultipleUploadRendering(boolean flag)

If it's true, then properties are rendered according to multiple file upload scenario

Parameters:

flag - The new propertiesForUpload value

getMultipleUploadRendering

public boolean getMultipleUploadRendering()

Used only for Multiple Upload Dialog, for rendering the properties according to multiple upload scenario

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

Specified by:

setExternalComponent in interface IContentEditable

Parameters:

uiDetails - The new externalComponent value

getExternalComponent

public com.sapportals.htmlb.Component getExternalComponent()

Gets the externalComponent attribute of the ResourcePropertiesControl object

Specified by:

getExternalComponent in interface IContentEditable

Returns:

The externalComponent value

setExternalLabelComponent

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

Sets the externalLabelComponent attribute of the ResourcePropertiesControl object

Parameters:

uiDetails - The new externalComponent value

getExternalLabelComponent

public com.sapportals.htmlb.Component getExternalLabelComponent()

Gets the externalLabelComponent 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

setName

public void setName(String displayName,
                    boolean force)

getName

public String getName()

Gets the name attribute of the ResourcePropertiesControl object

Returns:

The name value

setLastUserSelection

public void setLastUserSelection(String displayName)

Sets the name attribute of the ResourcePropertiesControl object

Parameters:

displayName - The new name value

getLastUserSelection

public String getLastUserSelection()

Gets the name attribute of the ResourcePropertiesControl object

Returns:

The name value

setProperties

public void setProperties(String properties)

getProperties

public String getProperties()

setMaintainable

public void setMaintainable(String properties)

getMaintainable

public String getMaintainable()

setHidden

public void setHidden(String properties)

getHidden

public String getHidden()

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

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}>

getAdditionalInformation

public Map getAdditionalInformation()

getAdditionalInformation

public Map getAdditionalInformation(boolean usedIMetaContext)

setAdditionalInformation

public void setAdditionalInformation(Map additionalInformation)

renderPropertiesTabs

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

Renders the group tabs

Parameters:

TabComponentList - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

renderSingleProperties

public com.sapportals.htmlb.Component renderSingleProperties(int fileIndex,
                                                             PropertiesArrayList propertiesList)

getSingleProperties

public IStructuredGroupItemList getSingleProperties()

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

onDelegateEvent

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

Throws:

WcmException

onRefresh

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

Throws:

WcmException

processEvent

public com.sapportals.wdf.event.WdfEvent processEvent(com.sapportals.htmlb.event.Event event,
                                                      boolean callReadInput)
                                               throws WcmException

Throws:

WcmException

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

readInputData

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

Overrides:

readInputData in class WcmBaseControl

Throws:

com.sapportals.wdf.WdfException

readSingleProperties

public PropertiesArrayList readSingleProperties(PropertiesArrayList cProperties,
                                                int fileIndex)
                                         throws com.sapportals.wdf.WdfException

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

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

checkPropertiesValidation

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

This method is looking for properties validation First is looking if the properties are semantic corectly ( Date , Time & Timestamp) Second is looking for the Standart validation Third is calling the properties validation class

Returns:

null if all the validation are correctly or a WdfPropertiesStatusInfoEvent if the validation failed

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

getDefaultPropertyMap

public IPropertyMap getDefaultPropertyMap()

Returns the default properties for the current property structure

Returns:

the default properties for the current property

processException

public com.sapportals.wdf.event.WdfEvent processException(Exception e,
                                                          String message)

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

allowSetProprties

public boolean allowSetProprties()
                          throws WcmException

Description copied from interface: IShowProperties

Checks if SetProperties is allowed to be done by the Properties dialog

Specified by:

allowSetProprties in interface IShowProperties

Throws:

WcmException

renderMetaNameLabelRequired

public com.sapportals.htmlb.Component renderMetaNameLabelRequired(IMetaName metaName,
                                                                  IMetaContext rendererContext,
                                                                  boolean isRequired)

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