com.sap.tc.webdynpro.clientserver.uielib.officecomp.api
Interface IWDOfficeControl

All Superinterfaces:

IWDAbstractActiveComponent, IWDUIElement, IWDViewElement

public interface IWDOfficeControl

extends IWDAbstractActiveComponent

Web Dynpro OfficeControl API. This component may be used to display an office document in-place inside the browser. This component is the backend stub for the client side ActiveX control or the Java applet.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static boolean	DEFAULT_ACTIVATE_IN_PLACE Default value of property activateInPlace.
static java.lang.String	DEFAULT_CONTROL_ID Default value of property controlId.
static java.lang.String	DEFAULT_DOCUMENT_NAME Default value of property documentName.
static WDOfficeDocumentType	DEFAULT_DOCUMENT_TYPE Default value of property documentType.
static boolean	DEFAULT_ENABLE_READ_WRITE Default value of property enableReadWrite.
static boolean	DEFAULT_SHOW_DECORATION Default value of property showDecoration.

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.activecomp.api.IWDAbstractActiveComponent

DEFAULT_HEIGHT, DEFAULT_WIDTH

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindActivateInPlace(IWDAttributeInfo attributeInfo) Binds property activateInPlace to the context attribute specified by the given attribute info.
void	bindActivateInPlace(java.lang.String path) Binds property activateInPlace to the context attribute specified by path.
void	bindDataSource(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by the given attribute info.
void	bindDataSource(java.lang.String path) Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.
void	bindDocumentName(IWDAttributeInfo attributeInfo) Binds property documentName to the context attribute specified by the given attribute info.
void	bindDocumentName(java.lang.String path) Binds property documentName to the context attribute specified by path.
void	bindDocumentType(IWDAttributeInfo attributeInfo) Binds property documentType to the context attribute specified by the given attribute info.
void	bindDocumentType(java.lang.String path) Binds property documentType to the context attribute specified by path.
void	bindEnableReadWrite(IWDAttributeInfo attributeInfo) Binds property enableReadWrite to the context attribute specified by the given attribute info.
void	bindEnableReadWrite(java.lang.String path) Binds property enableReadWrite to the context attribute specified by path.
java.lang.String	bindingOfActivateInPlace() Binding path of property activateInPlace.
java.lang.String	bindingOfDataSource() Note: This property must be bound to the context! Binding path of property dataSource.
java.lang.String	bindingOfDocumentName() Binding path of property documentName.
java.lang.String	bindingOfDocumentType() Binding path of property documentType.
java.lang.String	bindingOfEnableReadWrite() Binding path of property enableReadWrite.
java.lang.String	bindingOfShowDecoration() Binding path of property showDecoration.
void	bindShowDecoration(IWDAttributeInfo attributeInfo) Binds property showDecoration to the context attribute specified by the given attribute info.
void	bindShowDecoration(java.lang.String path) Binds property showDecoration to the context attribute specified by path.
boolean	getActivateInPlace() Returns the value of the activateInPlace property.
java.lang.String	getControlId() Returns the value of the controlId property.
java.lang.Object	getDataSource() Note: This property must be bound to the context! Returns the value of the dataSource property.
java.lang.String	getDocumentName() Returns the value of the documentName property.
WDOfficeDocumentType	getDocumentType() Returns the value of the documentType property.
boolean	getEnableReadWrite() Returns the value of the enableReadWrite property.
IWDAction	getOnClose() Returns the action to which the event onClose is mapped.
IWDAction	getOnSave() Returns the action to which the event onSave is mapped.
boolean	getShowDecoration() Returns the value of the showDecoration property.
IWDParameterMapping	mappingOfOnClose() Returns the parameter mapping of event onClose.
IWDParameterMapping	mappingOfOnSave() Returns the parameter mapping of event onSave.
void	setActivateInPlace(boolean value) Sets property activateInPlace to the new value.
void	setControlId(java.lang.String controlId) Sets property controlId to the given value.
void	setDataSource(java.lang.Object value) Note: This property must be bound to the context! Sets property dataSource to the new value.
void	setDocumentName(java.lang.String value) Sets property documentName to the new value.
void	setDocumentType(WDOfficeDocumentType value) Sets property documentType to the new value.
void	setEnableReadWrite(boolean value) Sets property enableReadWrite to the new value.
void	setOnClose(IWDAction action) Maps the event onClose to the given action.
void	setOnSave(IWDAction action) Maps the event onSave to the given action.
void	setShowDecoration(boolean value) Sets property showDecoration to the new value.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.activecomp.api.IWDAbstractActiveComponent

bindHeight, bindHeight, bindingOfHeight, bindingOfWidth, bindWidth, bindWidth, getHeight, getWidth, setHeight, setWidth

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_ACTIVATE_IN_PLACE

public static final boolean DEFAULT_ACTIVATE_IN_PLACE

Default value of property activateInPlace.

DEFAULT_CONTROL_ID

public static final java.lang.String DEFAULT_CONTROL_ID

Default value of property controlId.

DEFAULT_DOCUMENT_NAME

public static final java.lang.String DEFAULT_DOCUMENT_NAME

Default value of property documentName.

DEFAULT_DOCUMENT_TYPE

public static final WDOfficeDocumentType DEFAULT_DOCUMENT_TYPE

Default value of property documentType.

DEFAULT_ENABLE_READ_WRITE

public static final boolean DEFAULT_ENABLE_READ_WRITE

Default value of property enableReadWrite.

DEFAULT_SHOW_DECORATION

public static final boolean DEFAULT_SHOW_DECORATION

Default value of property showDecoration.

Method Detail

getOnClose

public IWDAction getOnClose()

Returns the action to which the event onClose is mapped. This is the event raised by the client control or the applet when the user closes the document.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnClose()

setOnClose

public void setOnClose(IWDAction action)

Maps the event onClose to the given action.

Parameters:

action - the action for the event

See Also:

getOnClose()

mappingOfOnClose

public IWDParameterMapping mappingOfOnClose()

Returns the parameter mapping of event onClose.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• boolean hasChanged - This is a parameter of the event onClose, this gives the information whether the document's data has changed or not at the time of close.

Returns:

parameter mapping list.

See Also:

getOnClose()

getOnSave

public IWDAction getOnSave()

Returns the action to which the event onSave is mapped. This is the event raised by the client side ActiveX control or the applet when the user does a save on the openend document

Returns:

the action to which the event is mapped

See Also:

mappingOfOnSave()

setOnSave

public void setOnSave(IWDAction action)

Maps the event onSave to the given action.

Parameters:

action - the action for the event

See Also:

getOnSave()

mappingOfOnSave

public IWDParameterMapping mappingOfOnSave()

Returns the parameter mapping of event onSave.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• boolean hasChanged - This is a parameter of the event onSave, this gives the information whether the document's data has changed or not at the time of Save.

Returns:

parameter mapping list.

See Also:

getOnSave()

bindActivateInPlace

public void bindActivateInPlace(java.lang.String path)

Binds property activateInPlace to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the activateInPlace property is bound

bindActivateInPlace

public void bindActivateInPlace(IWDAttributeInfo attributeInfo)

Binds property activateInPlace to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the activateInPlace property is bound

bindingOfActivateInPlace

public java.lang.String bindingOfActivateInPlace()

Binding path of property activateInPlace.

Returns:

the path of the context attribute to which the activateInPlace is currently bound

getActivateInPlace

public boolean getActivateInPlace()

Returns the value of the activateInPlace property. The initial value is true. Boolean property to specify whether the document has to be activated in place or in a separate window.

Returns:

the current value of the activateInPlace property

See Also:

setActivateInPlace(boolean)

setActivateInPlace

public void setActivateInPlace(boolean value)

Sets property activateInPlace to the new value.

Parameters:

value - the new value of the activateInPlace property

See Also:

getActivateInPlace()

getControlId

public java.lang.String getControlId()

Returns the value of the controlId property. The initial value is "". This is to be discarded because UIElement already has an id property.

Returns:

the value of the controlId property

See Also:

setControlId(String)

setControlId

public void setControlId(java.lang.String controlId)

Sets property controlId to the given value.

Parameters:

controlId - the new controlId value

See Also:

getControlId()

bindDataSource

public void bindDataSource(java.lang.String path)

Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the dataSource property is bound

bindDataSource

public void bindDataSource(IWDAttributeInfo attributeInfo)

Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the dataSource property is bound

bindingOfDataSource

public java.lang.String bindingOfDataSource()

Note: This property must be bound to the context! Binding path of property dataSource.

Returns:

the path of the context attribute to which the dataSource is currently bound

getDataSource

public java.lang.Object getDataSource()

Note: This property must be bound to the context! Returns the value of the dataSource property. The initial value is null. This is a binary property to hold the mass data of the document that is displayed.

Returns:

the current value of the dataSource property

See Also:

setDataSource(Object)

setDataSource

public void setDataSource(java.lang.Object value)

Note: This property must be bound to the context! Sets property dataSource to the new value.

Parameters:

value - the new value of the dataSource property

See Also:

getDataSource()

bindDocumentName

public void bindDocumentName(java.lang.String path)

Binds property documentName to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the documentName property is bound

bindDocumentName

public void bindDocumentName(IWDAttributeInfo attributeInfo)

Binds property documentName to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the documentName property is bound

bindingOfDocumentName

public java.lang.String bindingOfDocumentName()

Binding path of property documentName.

Returns:

the path of the context attribute to which the documentName is currently bound

getDocumentName

public java.lang.String getDocumentName()

Returns the value of the documentName property. The initial value is "". This property associates a name to the document.

Returns:

the current value of the documentName property

See Also:

setDocumentName(String)

setDocumentName

public void setDocumentName(java.lang.String value)

Sets property documentName to the new value.

Parameters:

value - the new value of the documentName property

See Also:

getDocumentName()

bindDocumentType

public void bindDocumentType(java.lang.String path)

Binds property documentType to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the documentType property is bound

bindDocumentType

public void bindDocumentType(IWDAttributeInfo attributeInfo)

Binds property documentType to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the documentType property is bound

bindingOfDocumentType

public java.lang.String bindingOfDocumentType()

Binding path of property documentType.

Returns:

the path of the context attribute to which the documentType is currently bound

getDocumentType

public WDOfficeDocumentType getDocumentType()

Returns the value of the documentType property. The initial value is WDOfficeDocumentType.MS_WORD. This is the type of the document to be displayed, e.g. MS_WORD, MS_EXCEL, STAR_CALC, STAR_WRITER.

Returns:

the current value of the documentType property

See Also:

setDocumentType(WDOfficeDocumentType)

setDocumentType

public void setDocumentType(WDOfficeDocumentType value)

Sets property documentType to the new value.

Parameters:

value - the new value of the documentType property

See Also:

getDocumentType()

bindEnableReadWrite

public void bindEnableReadWrite(java.lang.String path)

Binds property enableReadWrite to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the enableReadWrite property is bound

bindEnableReadWrite

public void bindEnableReadWrite(IWDAttributeInfo attributeInfo)

Binds property enableReadWrite to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the enableReadWrite property is bound

bindingOfEnableReadWrite

public java.lang.String bindingOfEnableReadWrite()

Binding path of property enableReadWrite.

Returns:

the path of the context attribute to which the enableReadWrite is currently bound

getEnableReadWrite

public boolean getEnableReadWrite()

Returns the value of the enableReadWrite property. The initial value is true. This property enables or disables the write operation on the document that is displayed in the ActiveX or the Java applet.

Returns:

the current value of the enableReadWrite property

See Also:

setEnableReadWrite(boolean)

setEnableReadWrite

public void setEnableReadWrite(boolean value)

Sets property enableReadWrite to the new value.

Parameters:

value - the new value of the enableReadWrite property

See Also:

getEnableReadWrite()

bindShowDecoration

public void bindShowDecoration(java.lang.String path)

Binds property showDecoration to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the showDecoration property is bound

bindShowDecoration

public void bindShowDecoration(IWDAttributeInfo attributeInfo)

Binds property showDecoration to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the showDecoration property is bound

bindingOfShowDecoration

public java.lang.String bindingOfShowDecoration()

Binding path of property showDecoration.

Returns:

the path of the context attribute to which the showDecoration is currently bound

getShowDecoration

public boolean getShowDecoration()

Returns the value of the showDecoration property. The initial value is true. This property has to be discarded.

Returns:

the current value of the showDecoration property

See Also:

setShowDecoration(boolean)

setShowDecoration

public void setShowDecoration(boolean value)

Sets property showDecoration to the new value.

Parameters:

value - the new value of the showDecoration property

See Also:

getShowDecoration()