Package de.lessvoid.nifty.controls.textfield

Class TextFieldControl

java.lang.Object

de.lessvoid.nifty.controls.AbstractController

de.lessvoid.nifty.controls.textfield.TextFieldControl

All Implemented Interfaces:

Controller, NiftyControl, TextField, TextFieldView

Deprecated.

Please use TextField when accessing NiftyControls.

@Deprecated
public class TextFieldControl
extends AbstractController
implements TextField, TextFieldView

A TextFieldControl.

Author:

void, Martin Karing <nitram@illarion.org>

Field Summary

Fields inherited from interface de.lessvoid.nifty.controls.TextField

UNLIMITED_LENGTH

Constructor Summary

Constructors

Constructor	Description
TextFieldControl()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	bind(Nifty niftyParam, Screen screenParam, Element newElement, Parameters properties)	Deprecated.
void	disableDeleteFilter()	Deprecated. Reset the delete filter to the default one that simply allows all input.
void	disableInputFilter()	Deprecated. Disable any active input filter and start using the default input filter again.
void	disablePasswordChar()	Deprecated. Disable the display of a password character and display the text as it was typed in.
void	enableDeleteFilter(TextFieldDeleteFilter filter)	Deprecated. Apply a filter to the delete operation on this text field.
void	enableInputFilter(TextFieldInputCharFilter filter)	Deprecated. Apply a filter to the input to this text field.
void	enableInputFilter(TextFieldInputCharSequenceFilter filter)	Deprecated. Apply a filter to the input to this text field.
void	enableInputFilter(TextFieldInputFilter filter)	Deprecated. Enable a filter to the input to this text field.
void	enablePasswordChar(char passwordChar)	Deprecated. Enable the password overlay for this text field.
java.lang.String	getDisplayedText()	Deprecated. Get the text that is displayed in the text field.
java.lang.String	getRealText()	Deprecated. Get the text that was typed in by the user into the text field.
java.lang.String	getText()	Deprecated. Get the current TextField text.
void	init(Parameters parameter)	Deprecated.
boolean	inputEvent(NiftyInputEvent inputEvent)	Deprecated.
boolean	isPasswordCharEnabled()	Deprecated. Check if the displayed text is currently hidden by the password characters.
void	layoutCallback()	Deprecated.
void	onClick(int mouseX, int mouseY)	Deprecated.
void	onClickMouseMove(int mouseX, int mouseY)	Deprecated.
void	onFocus(boolean getFocus)	Deprecated.
void	onStartScreen()	Deprecated.
void	setCursorPosition(int position)	Deprecated. Set the cursor to a new location within the text field.
void	setFormat(TextFieldDisplayFormat format)	Deprecated. Apply a display format to this text field.
void	setMaxLength(int maxLength)	Deprecated. Set the maximal length in characters that applies for this text field.
void	setText(java.lang.CharSequence text)	Deprecated. Set the text that is supposed to be displayed in the text field.
void	textChangeEvent(java.lang.String newText)	Deprecated. Publish a event indicating that the text in the text field got changed.

Methods inherited from class de.lessvoid.nifty.controls.AbstractController

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldControl

public TextFieldControl()

Deprecated.

Method Detail

bind

public void bind(@Nonnull
                 Nifty niftyParam,
                 @Nonnull
                 Screen screenParam,
                 @Nonnull
                 Element newElement,
                 @Nonnull
                 Parameters properties)

Deprecated.

Specified by:

bind in interface Controller

init

public void init(@Nonnull
                 Parameters parameter)

Deprecated.

Specified by:

init in interface Controller

Overrides:

init in class AbstractController

onStartScreen

public void onStartScreen()

Deprecated.

Specified by:

onStartScreen in interface Controller

layoutCallback

public void layoutCallback()

Deprecated.

Specified by:

layoutCallback in interface NiftyControl

Overrides:

layoutCallback in class AbstractController

onClick

public void onClick(int mouseX,
                    int mouseY)

Deprecated.

onClickMouseMove

public void onClickMouseMove(int mouseX,
                             int mouseY)

Deprecated.

inputEvent

public boolean inputEvent(@Nonnull
                          NiftyInputEvent inputEvent)

Deprecated.

Specified by:

inputEvent in interface Controller

onFocus

public void onFocus(boolean getFocus)

Deprecated.

Specified by:

onFocus in interface Controller

Overrides:

onFocus in class AbstractController

getText

@Nonnull
public java.lang.String getText()

Deprecated.

Description copied from interface: TextField

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.

Specified by:

getText in interface TextField

Returns:

the text that was typed into the text field

getRealText

@Nonnull
public java.lang.String getRealText()

Deprecated.

Description copied from interface: TextField

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

Specified by:

getRealText in interface TextField

Returns:

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

getDisplayedText

@Nonnull
public java.lang.String getDisplayedText()

Deprecated.

Description copied from interface: TextField

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.

Specified by:

getDisplayedText in interface TextField

Returns:

the text visible to the user

setText

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

Deprecated.

Description copied from interface: TextField

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

Specified by:

setText in interface TextField

Parameters:

text - the text that is supposed to be displayed

setMaxLength

public void setMaxLength(int maxLength)

Deprecated.

Description copied from interface: TextField

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.

Specified by:

setMaxLength in interface TextField

Parameters:

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

setCursorPosition

public void setCursorPosition(int position)

Deprecated.

Description copied from interface: TextField

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

Specified by:

setCursorPosition in interface TextField

Parameters:

position - the new location of the cursor

enableInputFilter

public void enableInputFilter(@Nullable
                              TextFieldInputFilter filter)

Deprecated.

Description copied from interface: TextField

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.

Specified by:

enableInputFilter in interface TextField

Parameters:

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

enableInputFilter

public void enableInputFilter(@Nullable
                              TextFieldInputCharFilter filter)

Deprecated.

Description copied from interface: TextField

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.

Specified by:

enableInputFilter in interface TextField

Parameters:

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

enableInputFilter

public void enableInputFilter(@Nullable
                              TextFieldInputCharSequenceFilter filter)

Deprecated.

Description copied from interface: TextField

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.

Specified by:

enableInputFilter in interface TextField

Parameters:

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

disableInputFilter

public void disableInputFilter()

Deprecated.

Description copied from interface: TextField

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

Specified by:

disableInputFilter in interface TextField

enableDeleteFilter

public void enableDeleteFilter(@Nullable
                               TextFieldDeleteFilter filter)

Deprecated.

Description copied from interface: TextField

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

Specified by:

enableDeleteFilter in interface TextField

Parameters:

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

disableDeleteFilter

public void disableDeleteFilter()

Deprecated.

Description copied from interface: TextField

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

Specified by:

disableDeleteFilter in interface TextField

setFormat

public void setFormat(@Nullable
                      TextFieldDisplayFormat format)

Deprecated.

Description copied from interface: TextField

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

Specified by:

setFormat in interface TextField

Parameters:

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

textChangeEvent

public void textChangeEvent(@Nonnull
                            java.lang.String newText)

Deprecated.

Description copied from interface: TextFieldView

Publish a event indicating that the text in the text field got changed.

Specified by:

textChangeEvent in interface TextFieldView

Parameters:

newText - the new text

enablePasswordChar

public void enablePasswordChar(char passwordChar)

Deprecated.

Description copied from interface: TextField

Enable the password overlay for this text field.

Specified by:

enablePasswordChar in interface TextField

Parameters:

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

disablePasswordChar

public void disablePasswordChar()

Deprecated.

Description copied from interface: TextField

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

Specified by:

disablePasswordChar in interface TextField

isPasswordCharEnabled

public boolean isPasswordCharEnabled()

Deprecated.

Description copied from interface: TextField

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

Specified by:

isPasswordCharEnabled in interface TextField

Returns:

true in case the actual input is hidden