com.sapportals.wcm.control.edit

Class ResourceHtmlEditorControl

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

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

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

Copyright 2004 SAP AG

Created 14. Mai 2003

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

Constructors

Constructor and Description
ResourceHtmlEditorControl() Constructor for the ResourceHtmlEditorControl object
ResourceHtmlEditorControl(String controlID) Constructor for the ResourceHtmlEditorControl object

Method Summary

Modifier and Type	Method and Description
protected void	createNestedControls() Register composite parts
String	getExtension() Get the extension that is used when saving a Resource in the HtmlEditControl
String	getInfoMessage()
boolean	getNameInvalidFlag() Gets the nameInvalidFlag attribute of the ResourceHtmlEditorControl object
boolean	getNewResourceFlag() Gets the newResourceFlag attribute of the ResourceHtmlEditorControl object
String	getProperties()
String	getPropertyStructureName()
String	getResourceType()
boolean	getSendBackEvent() Gets the sendBackEvent attribute of the ResourceUploadControl object
boolean	getSendOverviewEvent()
boolean	getShowCustomProperty() Getter method of showCustomProperty
String	getStartUri() Gets the startUri attribute of the ResourceHtmlEditorControl object
boolean	getUiDetailsHeader()
boolean	isForceExtension() Getter method of setForceExtension
boolean	isSaveContentAsDescription() Set the flag whether the entered content is saved in description property as well
boolean	isStandalone() Gets the standalone attribute of the ResourceHtmlEditorControl object
boolean	isUsePortalStyle()
boolean	isUseRelativeLinks()
com.sapportals.wdf.event.WdfEvent	onCancel(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onCustomProperty(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onEdit(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onExit(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onLock(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onSave(com.sapportals.htmlb.event.Event event) save the resource
com.sapportals.wdf.event.WdfEvent	onSaveAndLock(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onSaveAndUnlock(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onUnlockAndDiscardChanges(com.sapportals.htmlb.event.Event event) Description of the Method
protected void	readInputData()
void	receive(com.sapportals.wdf.event.WdfEvent cflEvent) Description of the Method
com.sapportals.htmlb.Component	render() Renders the html editor control
void	setExtension(String extension) Set the extension of the resource that is created in the HtmlEditControl
void	setForceExtension(boolean flag) The extension (provided by method setExtension or the default extension) is always set by the control; regardless of the extension the user provides
void	setInfoMessage(String infoMessage)
void	setNameInvalidFlag(boolean flag) Sets the nameInvalidFlag attribute of the ResourceHtmlEditorControl object
void	setNewResourceFlag(boolean flag) Sets the newResourceFlag attribute of the ResourceHtmlEditorControl object
void	setProperties(String properties)
void	setPropertyStructureName(String properties)
void	setResourceType(String newResourceTypes)
void	setSaveContentAsDescription(boolean flag) Set the flag that the entered content is saved in description property as well
void	setSendBackEvent(boolean flag) Sets the sendBackEvent attribute of the ResourceUploadControl object
void	setSendOverviewEvent(boolean sendOverviewEvent)
void	setShowCustomProperty(boolean flag) Sets the showCustomProperty attribute of the ResourceHtmlEditorControl object
void	setStandalone(boolean isStandalone) Sets the standalone attribute of the ResourceHtmlEditorControl object
void	setStartUri(String startUri) Sets the startUri attribute of the ResourceHtmlEditorControl object
void	setUiDetailsHeader(boolean uiDetails)
void	setUsePortalStyle(boolean usePortalStyle)
void	setUseRelativeLinks(boolean useRelativeLinks)

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

ResourceHtmlEditorControl

public ResourceHtmlEditorControl()

Constructor for the ResourceHtmlEditorControl object

ResourceHtmlEditorControl

public ResourceHtmlEditorControl(String controlID)

Constructor for the ResourceHtmlEditorControl object

Parameters:

controlID - Description of the param

Method Detail

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

setSendBackEvent

public void setSendBackEvent(boolean flag)

Sets the sendBackEvent attribute of the ResourceUploadControl object

Parameters:

flag - The new sendBackEvent value

getSendBackEvent

public boolean getSendBackEvent()

Gets the sendBackEvent attribute of the ResourceUploadControl object

Returns:

The sendBackEvent value

setNewResourceFlag

public void setNewResourceFlag(boolean flag)

Sets the newResourceFlag attribute of the ResourceHtmlEditorControl object

Parameters:

flag - The new newResourceFlag value

getNewResourceFlag

public boolean getNewResourceFlag()

Gets the newResourceFlag attribute of the ResourceHtmlEditorControl object

Returns:

The newResourceFlag value

setNameInvalidFlag

public void setNameInvalidFlag(boolean flag)

Sets the nameInvalidFlag attribute of the ResourceHtmlEditorControl object

Parameters:

flag - The new nameInvalidFlag value

getNameInvalidFlag

public boolean getNameInvalidFlag()

Gets the nameInvalidFlag attribute of the ResourceHtmlEditorControl object

Returns:

The nameInvalidFlag value

setUiDetailsHeader

public void setUiDetailsHeader(boolean uiDetails)

getUiDetailsHeader

public boolean getUiDetailsHeader()

setStandalone

public void setStandalone(boolean isStandalone)

Sets the standalone attribute of the ResourceHtmlEditorControl object

Parameters:

isStandalone - The new standalone value

isStandalone

public boolean isStandalone()

Gets the standalone attribute of the ResourceHtmlEditorControl object

Returns:

The standalone value

setExtension

public void setExtension(String extension)

Set the extension of the resource that is created in the HtmlEditControl

Parameters:

extension - The new extension value

getExtension

public String getExtension()

Get the extension that is used when saving a Resource in the HtmlEditControl

Returns:

The extension value

setForceExtension

public void setForceExtension(boolean flag)

The extension (provided by method setExtension or the default extension) is always set by the control; regardless of the extension the user provides

Parameters:

flag - The new forceExtension value

isForceExtension

public boolean isForceExtension()

Getter method of setForceExtension

Returns:

The forceExtension value

setSaveContentAsDescription

public void setSaveContentAsDescription(boolean flag)

Set the flag that the entered content is saved in description property as well

Parameters:

flag - The new saveContentAsDescription value

isSaveContentAsDescription

public boolean isSaveContentAsDescription()

Set the flag whether the entered content is saved in description property as well

Returns:

The saveContentAsDescription value

getStartUri

public String getStartUri()

Gets the startUri attribute of the ResourceHtmlEditorControl object

Returns:

The startUri value

setStartUri

public void setStartUri(String startUri)

Sets the startUri attribute of the ResourceHtmlEditorControl object

Parameters:

startUri - The new startUri value

setShowCustomProperty

public void setShowCustomProperty(boolean flag)

Sets the showCustomProperty attribute of the ResourceHtmlEditorControl object

Parameters:

flag - The new showCustomProperty value

getShowCustomProperty

public boolean getShowCustomProperty()

Getter method of showCustomProperty

Returns:

The showCustomProperty value

setSendOverviewEvent

public void setSendOverviewEvent(boolean sendOverviewEvent)

getSendOverviewEvent

public boolean getSendOverviewEvent()

setInfoMessage

public void setInfoMessage(String infoMessage)

getInfoMessage

public String getInfoMessage()

setUsePortalStyle

public void setUsePortalStyle(boolean usePortalStyle)

isUsePortalStyle

public boolean isUsePortalStyle()

setUseRelativeLinks

public void setUseRelativeLinks(boolean useRelativeLinks)

isUseRelativeLinks

public boolean isUseRelativeLinks()

render

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

Renders the html editor control

Specified by:

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

Returns:

HTMLB Component

Throws:

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

onLock

public com.sapportals.wdf.event.WdfEvent onLock(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

onSaveAndUnlock

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

Throws:

WcmException

onSaveAndLock

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

Throws:

WcmException

onEdit

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

Throws:

WcmException

onCustomProperty

public com.sapportals.wdf.event.WdfEvent onCustomProperty(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

onSave

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

save the resource

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

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

onUnlockAndDiscardChanges

public com.sapportals.wdf.event.WdfEvent onUnlockAndDiscardChanges(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

onExit

public com.sapportals.wdf.event.WdfEvent onExit(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 of the Method

Specified by:

receive in interface com.sapportals.wdf.event.WdfEventReceiver

Overrides:

receive in class WcmResourceControl

Parameters:

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

setResourceType

public void setResourceType(String newResourceTypes)

getResourceType

public String getResourceType()

setProperties

public void setProperties(String properties)

getProperties

public String getProperties()

setPropertyStructureName

public void setPropertyStructureName(String properties)

getPropertyStructureName

public String getPropertyStructureName()