de.hillenbrand.jreqtools
Class StringRequester

java.lang.Object
  de.hillenbrand.jreqtools.AbstractRequester
      de.hillenbrand.jreqtools.OkCancelRequester
          de.hillenbrand.jreqtools.StringRequester

Direct Known Subclasses:

ByteRequester, DoubleRequester, FloatRequester, IntegerRequester, LongRequester, ShortRequester

public class StringRequester
extends OkCancelRequester

A requester for simple strings.

Field Summary

Fields inherited from class de.hillenbrand.jreqtools.OkCancelRequester

answer, cancel, comment, drawFirstSeparator, drawSecondSeparator, icon, ok

Fields inherited from class de.hillenbrand.jreqtools.AbstractRequester

CANCEL, dialog, listener, message, OK, title

Constructor Summary

StringRequester(java.lang.String message, java.lang.String defaultstring)
Constructs a new StringRequester with an empty default value.

StringRequester(java.lang.String title, java.lang.String message, java.lang.String defaultstring)
Constructs a new StringRequester.

Method Summary

protected javax.swing.JComponent	getOkTriggerComponent() Returns the component that will trigger the Ok button.
java.lang.String	getString() Gets the string that has been entered or selected by the user.
protected javax.swing.JPanel	getUserPanel() Returns the panel of the requester.
protected void	ok() This method will be called when the user presses the Ok button.
protected void	prepareForRequest() This method will be called right before the request will be shown.
void	setDefaultChoices(java.lang.Object[] choices) The values of the array will be presented to the user as default values.
void	setDefaultChoices(java.lang.Object[] choices, java.lang.Object selected) The values of the array will be presented to the user as default values.
void	setString(java.lang.String newstring) Sets the string in the requester.
void	setStringChecker(StringChecker newchecker) Sets a StringChecker to be used for accepting an entered string.
java.lang.String	validateData() This method is used to validate the data entered by the user.

Methods inherited from class de.hillenbrand.jreqtools.OkCancelRequester

cancel, createContentPane, getComment, getDefaultButton, getIcon, getPreferredRequesterSize, getReturnValue, isDrawFirstSeparator, isDrawSecondSeparator, setCancelButtonText, setComment, setDrawFirstSeparator, setDrawSecondSeparator, setDrawSeparators, setIcon, setOkButtonText, simulateCancelPressed, simulateOkPressed

Methods inherited from class de.hillenbrand.jreqtools.AbstractRequester

_checkLocation, _checkLocation, _checkSize, _checkSize, checkForClass, enableHelpKey4JavaHelp, getBounds, getLocation, getMessage, getSize, getTitle, request, request, request, setBorder, setBounds, setBounds, setLocation, setLocation, setMessage, setSize, setSize, setTitle, setVisible, showError, showException, showMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringRequester

public StringRequester(java.lang.String message,
                       java.lang.String defaultstring)

Constructs a new StringRequester with an empty default value.

Parameters:

message - - The message to be shown in the requester.

defaultstring - - The initial value of the text field.

StringRequester

public StringRequester(java.lang.String title,
                       java.lang.String message,
                       java.lang.String defaultstring)

Constructs a new StringRequester.

Parameters:

title - - Title of the requester.

message - - The message to be shown in the requester.

defaultstring - - The initial value of the text field.

Method Detail

getOkTriggerComponent

protected javax.swing.JComponent getOkTriggerComponent()

Returns the component that will trigger the Ok button.

Overrides:

getOkTriggerComponent in class OkCancelRequester

Returns:

getString

public java.lang.String getString()

Gets the string that has been entered or selected by the user.

Returns:

getUserPanel

protected javax.swing.JPanel getUserPanel()

Returns the panel of the requester.

Specified by:

getUserPanel in class OkCancelRequester

Returns:

ok

protected void ok()

This method will be called when the user presses the Ok button.

Overrides:

ok in class OkCancelRequester

prepareForRequest

protected void prepareForRequest()

This method will be called right before the request will be shown.

Overrides:

prepareForRequest in class OkCancelRequester

setDefaultChoices

public void setDefaultChoices(java.lang.Object[] choices)

The values of the array will be presented to the user as default values.

Parameters:

choices - The possible values.

setDefaultChoices

public void setDefaultChoices(java.lang.Object[] choices,
                              java.lang.Object selected)

The values of the array will be presented to the user as default values.

Parameters:

choices - The possible values.

selected - The initially selected default value. This will overwrite the value set using setString()

setString

public void setString(java.lang.String newstring)

Sets the string in the requester.

Parameters:

newstring -

setStringChecker

public void setStringChecker(StringChecker newchecker)

Sets a StringChecker to be used for accepting an entered string.

Parameters:

newchecker - The string checker that will be used for testing the values entered by the user.

validateData

public java.lang.String validateData()

This method is used to validate the data entered by the user.

Overrides:

validateData in class OkCancelRequester

Returns:

error string, null if everything is ok