Package de.lessvoid.nifty.controls.textfield.format

Class FormatPassword

java.lang.Object

de.lessvoid.nifty.controls.textfield.format.FormatPassword

All Implemented Interfaces:

TextFieldDisplayFormat

public class FormatPassword
extends java.lang.Object
implements TextFieldDisplayFormat

This format is used to generate a password field. It will overlay every character with a default character.

Author:

Martin Karing <nitram@illarion.org>

Constructor Summary

Constructors

Constructor	Description
FormatPassword()	Create a new instance with the default character to hide the real text.
FormatPassword(char passwordChar)	Create a new instance and set the character used to hide the password.

Method Summary

Modifier and Type	Method	Description
java.lang.CharSequence	getDisplaySequence(java.lang.CharSequence original, int start, int end)	Get a part of the original text converted into the one that is supposed to be displayed.
char	getPasswordChar()	Get the character that is used to replace the real contents of the text.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatPassword

public FormatPassword()

Create a new instance with the default character to hide the real text. The character used it: *.

FormatPassword

public FormatPassword(char passwordChar)

Create a new instance and set the character used to hide the password.

Parameters:

passwordChar - the character that is displayed instead of the real text

Method Detail

getPasswordChar

public char getPasswordChar()

Get the character that is used to replace the real contents of the text.

Returns:

the password character

getDisplaySequence

@Nonnull
public java.lang.CharSequence getDisplaySequence(@Nonnull
                                                 java.lang.CharSequence original,
                                                 int start,
                                                 int end)

Description copied from interface: TextFieldDisplayFormat

Get a part of the original text converted into the one that is supposed to be displayed.

Specified by:

getDisplaySequence in interface TextFieldDisplayFormat

Parameters:

original - the original text

start - the index of the first character that should be converted

end - the index of the first character after the area that should be converted

Returns:

the converted sub-sequence of the original text