com.inet.viewer

Interface CustomPromptEditor

All Superinterfaces:

ViewerComponent

public interface CustomPromptEditor
extends ViewerComponent

CustomPromptEditors are used to display custom editors for specific prompts. They are registered using the method ReportViewer.setCustomPromptEditor(String, int, CustomPromptEditor). When a prompt is requested with a name for which a CustomPromptEditor has been registered, the editor is fetched via ViewerComponent.getComponent(), its default values are set via setValue(Object), and its value is then requested via getValue().

Since:

7.8

See Also:

ReportViewer.setCustomPromptEditor(String, int, CustomPromptEditor)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getValue() Returns the currently chosen value for the prompt for which this editor is being used.
void	setValue(java.lang.Object value) Sets the currently set value of the prompt for which this editor is being used.

Methods inherited from interface com.inet.viewer.ViewerComponent

getComponent

Method Detail

setValue

void setValue(java.lang.Object value)

Sets the currently set value of the prompt for which this editor is being used.

Parameters:

value - currently set value of the prompt

Since:

7.8

getValue

java.lang.Object getValue()

Returns the currently chosen value for the prompt for which this editor is being used. Note that the object returned depends on the value type of the prompt:

• NUMBER : java.lang.Double
• CURRENCY : java.lang.Double
• BOOLEAN : java.lang.Boolean
• DATE : java.sql.Date
• TIME : java.sql.Time
• DATETIME : java.sql.Timestamp
• STRING : java.lang.String
• RANGE: Range
• If the return value is to be multiple values, return a Vector.

Returns:

the currently chosen value for the prompt.

Since:

7.8

See Also:

Vector