com.sap.tc.webdynpro.progmodel.api
Interface IWDComponent

All Superinterfaces:

IWDController

public interface IWDComponent

extends IWDController

Generic API of all Web Dynpro component controllers. This interface is implemented by all Web Dynpro components.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_progmodel/java/com/sap/tc/webdynpro/progmodel/api/IWDComponent.java#2 $

Method Summary

void	addEventHandler(IWDEventInfo event, IWDEventHandlerInfo eventHandler, IWDController controller) Subscribe the specified event handler to the specified event.
IWDApplication	getApplication() Returns the application to which this component belongs.
IWDComponentInfo	getComponentInfo() Returns the metadata describing this component.
WDDeployableObjectPart	getDeployableObjectPart() Returns the deployable object part of this component.
IWDMessageManager	getMessageManager() Returns this component's message manager.
IWDTextAccessor	getTextAccessor() This method returns the text accessor for this component.
IWDValidationCheck	getValidationCheck() Returns the validation check interface for this component.
IWDWindowManager	getWindowManager() Returns the factory object to create windows.
boolean	isApplicationRoot() Returns true, iff this component is the toplevel component of the application.
void	removeEventHandler(IWDEventInfo event, IWDEventHandlerInfo eventHandler, IWDController controller) Unsubscribe the specified event handler from the specified event.
void	removePendingUserInput() Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Context attributes simply may be overwritten in a non validating action event handler, thereby removing any pending input for them.

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

getAction, getComponent, getContext, getControllerInfo, getMessage, getMessage, getName, getPackageName, getQualifiedName, getText, getText

Method Detail

getTextAccessor

public IWDTextAccessor getTextAccessor()

This method returns the text accessor for this component. The text accessor provides access to translatable texts in resource bundles.

Returns:

the text accessor for this component

getMessageManager

public IWDMessageManager getMessageManager()

Returns this component's message manager. There is only ever one message manager per component. A message manager is the interface through which all views in a component can report exceptions, warnings and success messages to the client.

Returns:

this component's message manager

getValidationCheck

public IWDValidationCheck getValidationCheck()

Returns the validation check interface for this component. The validation check is used to check for invalid context attributes and access external string representations.

Returns:

the validation check interface for this component

removePendingUserInput

public void removePendingUserInput()

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Context attributes simply may be overwritten in a non validating action event handler, thereby removing any pending input for them.

Removes all pending user input including lead selection updates in an appropriate scope.

getComponentInfo

public IWDComponentInfo getComponentInfo()

Returns the metadata describing this component.

Returns:

the component metadata object

getWindowManager

public IWDWindowManager getWindowManager()

Returns the factory object to create windows. A window represents the internal interface to the interface view of the component.

Returns:

the factory to create windows

getDeployableObjectPart

public WDDeployableObjectPart getDeployableObjectPart()

Returns the deployable object part of this component.

Returns:

the deployable object part of this component

addEventHandler

public void addEventHandler(IWDEventInfo event,
                            IWDEventHandlerInfo eventHandler,
                            IWDController controller)

Subscribe the specified event handler to the specified event. Event and event handler must be owned by controllers of this component.

Parameters:

event - Repository object of the event to subscribe to

eventHandler - Repository object of the event handler

controller - Controller which owns the event handler

removeEventHandler

public void removeEventHandler(IWDEventInfo event,
                               IWDEventHandlerInfo eventHandler,
                               IWDController controller)

Unsubscribe the specified event handler from the specified event. The event must have been registered with the corresponding event before.

Parameters:

event - Repository object of the event to unsubscribe from

eventHandler - Repository object of the event handler

controller - Controller which owns the event handler

isApplicationRoot

public boolean isApplicationRoot()

Returns true, iff this component is the toplevel component of the application.

Returns:

true, iff this component is the toplevel component of the application.

getApplication

public IWDApplication getApplication()

Returns the application to which this component belongs. To ensure that components will be reusable, only call this method if isApplicationRoot() == true.