Methods of the UI Element APIs 

The methods of all UI element APIs are, as a matter of principle, built in the same manner.

You can find detailed descriptions of the individual methods in the Javadocs in the SDN or in the NWDS help under API References.

 

Methods for Property Handling

One Get- and one Set method exists for the property of a user interface element:

Getter- and Setter methods

·        The Get methods return the value of a property or an element. The name of the method is created according to the following pattern: get<Name of the property>
Example: IWDTable, property: design, method: getDesign.

·        The Set methods set the value of a property or an element. If a property is readOnly, then this method is not implemented.
The name of the method is created according to the following pattern: set<Name of the property>
Example: IWDTable, property: design, method: setDesign.

Data Binding Methods

If a property can, or must be bound to the context, the respective Bind- and BindingOf methods are available.

·        The Bind methods bind the value of a property to the Context-Element specified by the path. The name of the method is created according to the following pattern: bind<Name of property>
Example: IWDTable, property: design, method: bindDesign.

·        The BindingOf methods return the path of the context element to which a property is bound and return NULL if no binding exists. The name of the method is created according to the following pattern: bindingOf<Name of the property>
Example: IWDTable, property: design, method: bindingOfDesign.

Methods for Event Handling

·        The Get methods return the value of an event. The name of the method is created according to the following pattern: get<Name of the property>
Example: IWDTable, event: onFilter, method: getOnFilter.

·        The Set methods set the value of an event. The name of the method is created according to the following pattern: set<Name of the property>
Example: IWDTable, event: onFilter, method: setOnFilter.

·        The MappingOf method return the parameter mapping for an event. The name of the method is created according to the following pattern: mappingOf<Name of the event>
Example: IWDTable, event: onFilter, method: mappingOfOnFilter.

Methods for Handling of Aggregated Elements

If an interface element can contain other elements, the following methods are available:

·        Two Add methods that add an element.

·        If only the element is transferred as parameter, then the element is added at the and of a list

·        If an index is transferred as well, then this element is transferred at the specified index position.

The name of both methods is created according to the following pattern: add<Name of the element>
Example: IWDTable, element: Column, method: addColumn.

·        The Destroy methods remove and delete the respective elements.
The name of the method is created according to the following pattern:
destroy<Name of the element>.
Example: IWDTable, element: Column, method: destroyColumn.
If all elements of a type are to be removed, then the name is: destroyAll<Name of the elements>
Example: IWDTable, element: Column, method: destroyAllColumns.

·        The Get methods are used to determine the allocation to the superordinate or subordinate elements. The name of the method is created according to the following pattern: get<Name of the elements>
Example: IWDTable, element: Column, method: getColumn.

·        The Has methods test whether aggregated elements exist within this element. The name of the method is created according to the following pattern: has<Name of the elements>
Example: IWDTable, element: Column, method: hasColumns.

·        The Iterate methods return an iterator about all aggregated elements within the current element. The name of the method is created according to the following pattern: iterate<Name of the elements>
Example: IWDTable, element: Column, method: iterateColumns.

·        The Remove methods remove the respective aggregated elements. These are retained, and can later be added to the current element again.
You can delete individual or all elements.

·        On individual elements, you can either transfer the index or the ID, the method is created according to the following pattern:
remove<Name of the element>.
Example: IWDTable, element: Column, method: removeColumn.

·        If you want to remove all elements, use a method that is created according to the following pattern: removeAll<Name of the elements>
Example: IWDTable, element: Column, method: removeAllColumns.

Some user interface elements have additional methods; These are described there.