|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UIComponent
the interface making a class a JETERS-UI-component.
for details about user interface components and other JETERS concepts
read the documentation provided for the project.
Method Summary | |
---|---|
java.lang.String |
confirmChanges(java.lang.String label,
java.lang.String oldVersion,
java.lang.String newVersion,
java.lang.String descriptionOfChanges,
boolean allowCancel)
allows the user to accept/decline changes made by a replacer component (i.e. an implementation of ReplacerComponent ). |
net.sf.jeters.componentInterface.dataStructs.NamedDataSet |
request(net.sf.jeters.componentInterface.dataStructs.UIRequest... requests)
way for other components to communicate with the user via the UI |
Method Detail |
---|
java.lang.String confirmChanges(java.lang.String label, java.lang.String oldVersion, java.lang.String newVersion, java.lang.String descriptionOfChanges, boolean allowCancel)
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.
label
- a kind of "name" (filename, article title, ...);
can be "", but not null.oldVersion
- the text before the replacer's actions;
can be "", but not null.newVersion
- the text after the replacer's actions;
can be "", but not null.descriptionOfChanges
- an explanation of the differences between
oldVersion and newVersion provided by the
replacer component; can be "", but not null.allowCancel
- if false, cancelling must not be possible;
if true, possibility depends on UI
net.sf.jeters.componentInterface.dataStructs.NamedDataSet request(net.sf.jeters.componentInterface.dataStructs.UIRequest... requests)
requests
- array of UIRequest
s (can use vararg-syntax).
Neither the array nor the array's entries may be null.
NamedDataSet
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |