Package de.lessvoid.nifty.controls

Interface TextField

All Superinterfaces:

NiftyControl

All Known Implementing Classes:

TextFieldControl

public interface TextField
extends NiftyControl

Field Summary

Fields

Modifier and Type	Field	Description
static int	UNLIMITED_LENGTH	This is the constant the maximal length needs to be set to in order to set it to a unlimited.

Method Summary

Modifier and Type	Method	Description
void	disableDeleteFilter()	Reset the delete filter to the default one that simply allows all input.
void	disableInputFilter()	Disable any active input filter and start using the default input filter again.
void	disablePasswordChar()	Deprecated. Use setFormat(TextFieldDisplayFormat) with the argument null to reset the display format
void	enableDeleteFilter(TextFieldDeleteFilter filter)	Apply a filter to the delete operation on this text field.
void	enableInputFilter(TextFieldInputCharFilter filter)	Apply a filter to the input to this text field.
void	enableInputFilter(TextFieldInputCharSequenceFilter filter)	Apply a filter to the input to this text field.
void	enableInputFilter(TextFieldInputFilter filter)	Enable a filter to the input to this text field.
void	enablePasswordChar(char passwordChar)	Deprecated. Rather then using this function apply a new text format using (TextFieldDisplayFormat) with the FormatPassword.
java.lang.String	getDisplayedText()	Get the text that is displayed in the text field.
java.lang.String	getRealText()	Get the text that was typed in by the user into the text field.
java.lang.String	getText()	Deprecated. Better use getRealText()
boolean	isPasswordCharEnabled()	Deprecated. There is no replacement. Void did not like it! Complain to him!
void	setCursorPosition(int position)	Set the cursor to a new location within the text field.
void	setFormat(TextFieldDisplayFormat format)	Apply a display format to this text field.
void	setMaxLength(int maxLength)	Set the maximal length in characters that applies for this text field.
void	setText(java.lang.CharSequence text)	Set the text that is supposed to be displayed in the text field.

Methods inherited from interface de.lessvoid.nifty.controls.NiftyControl

disable, enable, getElement, getHeight, getId, getStyle, getWidth, hasFocus, isBound, isEnabled, layoutCallback, setEnabled, setFocus, setFocusable, setHeight, setId, setStyle, setWidth

Field Detail

UNLIMITED_LENGTH

static final int UNLIMITED_LENGTH

This is the constant the maximal length needs to be set to in order to set it to a unlimited.

See Also:

Constant Field Values

Method Detail

disablePasswordChar

@Deprecated
void disablePasswordChar()

Deprecated. Use setFormat(TextFieldDisplayFormat) with the argument null to reset the display format

Disable the display of a password character and display the text as it was typed in.

enablePasswordChar

@Deprecated
void enablePasswordChar(char passwordChar)

Deprecated. Rather then using this function apply a new text format using (TextFieldDisplayFormat) with the FormatPassword.

Enable the password overlay for this text field.

Parameters:

passwordChar - the character all characters of the real text are replaced with

getDisplayedText

@Nonnull
java.lang.String getDisplayedText()

Get the text that is displayed in the text field. Depending on the format that is applied to this text field its possible that this text is not equal to the text that was actually typed into the text field.

Returns:

the text visible to the user

getRealText

@Nonnull
java.lang.String getRealText()

Get the text that was typed in by the user into the text field. Depending on the filter applied by enableInputFilter(TextFieldInputFilter) its possible that this text does not equal the text that is actually displayed in the text field.

Returns:

the text that was typed in by the user into the text field

getText

@Nonnull
@Deprecated
java.lang.String getText()

Deprecated. Better use getRealText()

Get the current TextField text. This is the text that was typed into the text field. Its possible that this is not equal to the text that is actually displayed in the text field.

Returns:

the text that was typed into the text field

isPasswordCharEnabled

@Deprecated
boolean isPasswordCharEnabled()

Deprecated. There is no replacement. Void did not like it! Complain to him!

Check if the displayed text is currently hidden by the password characters.

Returns:

true in case the actual input is hidden

setCursorPosition

void setCursorPosition(int position)

Set the cursor to a new location within the text field. The applied value is automatically capped to valid values.

Parameters:

position - the new location of the cursor

enableInputFilter

void enableInputFilter(@Nullable
                       TextFieldInputFilter filter)

Enable a filter to the input to this text field. Once set only characters that are allowed by the filter are usable.

Be aware that calling this function will overwrite all filters applied to this text field before. No matter what function was used to apply the filter.

Parameters:

filter - the new filter or null to reset to the default filter that allows all input

enableInputFilter

void enableInputFilter(@Nullable
                       TextFieldInputCharFilter filter)

Apply a filter to the input to this text field. Once set only characters that are allowed by the filter are usable.

Be aware that calling this function will overwrite all filters applied to this text field before. No matter what function was used to apply the filter.

Parameters:

filter - the new filter or null to reset to the default filter that allows all input

enableInputFilter

void enableInputFilter(@Nullable
                       TextFieldInputCharSequenceFilter filter)

Apply a filter to the input to this text field. Once set only characters that are allowed by the filter are usable.

Be aware that calling this function will overwrite all filters applied to this text field before. No matter what function was used to apply the filter.

Parameters:

filter - the new filter or null to reset to the default filter that allows all input

disableInputFilter

void disableInputFilter()

Disable any active input filter and start using the default input filter again.

enableDeleteFilter

void enableDeleteFilter(@Nullable
                        TextFieldDeleteFilter filter)

Apply a filter to the delete operation on this text field. Once set only delete operations permitted by this filter are possible.

Parameters:

filter - the new filter or null to reset to the default filter that allows all delete operations

disableDeleteFilter

void disableDeleteFilter()

Reset the delete filter to the default one that simply allows all input.

setFormat

void setFormat(@Nullable
               TextFieldDisplayFormat format)

Apply a display format to this text field. This display formats allow changing the displayed text without effecting the text that was typed in.

Parameters:

format - the new format or null to reset to the default format that simply displays the text that was typed in

setMaxLength

void setMaxLength(int maxLength)

Set the maximal length in characters that applies for this text field. Once set it will be impossible for the user to type in more characters then set here.

Parameters:

maxLength - the maximal amount of characters allowed in this text field or UNLIMITED_LENGTH in case no limit is supposed to be set

setText

void setText(@Nonnull
             java.lang.CharSequence text)

Set the text that is supposed to be displayed in the text field.

Parameters:

text - the text that is supposed to be displayed