jeters.core
Interface UIComponent

All Superinterfaces:
Component
All Known Subinterfaces:
UIComponent_HomeView
All Known Implementing Classes:
DefaultCUI, DefaultGUI

public interface UIComponent
extends Component

the interface making a class a JETERS-UI-component.

for details about user interface components and other JETERS concepts see *++LINK CONCEPTS (#UI components) TARGET:komp.Seite++*


Method Summary
 java.lang.String confirmChanges(java.lang.String label, java.lang.String oldVersion, java.lang.String newVersion, java.lang.String descriptionOfChanges)
          allows the user to accept/decline changes made by a replacer component (i.e. an implementation of ReplacerComponent).
 NamedDataSet request(UIRequest... requests)
          way for other components to communicate with the user via the UI
 

Method Detail

confirmChanges

java.lang.String confirmChanges(java.lang.String label,
                                java.lang.String oldVersion,
                                java.lang.String newVersion,
                                java.lang.String descriptionOfChanges)
allows the user to accept/decline changes made by a replacer component (i.e. an implementation of ReplacerComponent). UIComponents should at least offer the possibility of choosing between the old and the new version of the text. Additionally, they can allow manual editing.

Parameters:
label - a kind of "name" (filename, article title, ...). This parameter can be "", but not null.
oldVersion - the text before the replacer's actions. This parameter can be "", but not null.
newVersion - the text after the replacer's actions. This parameter can be "", but not null.
descriptionOfChanges - an explanation of the differences between oldVersion and newVersion provided by the replacer component. This parameter can be "", but not null.
Returns:
String object containing the corrected text as the user wants it, may also be different from both oldVersion and newVersion. Not null.

request

NamedDataSet request(UIRequest... requests)
way for other components to communicate with the user via the UI

Parameters:
requests - array of UIRequest-objects (can use vararg-syntax). Neither the array nor the array's entries may be null.
Returns:
the user's replies to the requests, as a NamedDataSet.
The name of a reply must equal the name of the answered request. null must not be returned! If getting proper replies fails, return a NamedDataSet that is empty or contains at least those replies which were properly entered.