Inheritance diagram for g4p_controls.GPassword:

[legend]

Public Member Functions
void	draw ()

void	flashCaret (GTimer timer)

String	getPassword ()

PGraphics	getSnapshot ()

int	getWordLength ()

	GPassword (PApplet theApplet, float p0, float p1, float p2, float p3)

	GPassword (PApplet theApplet, float p0, float p1, float p2, float p3, int sbPolicy)

void	keyEvent (KeyEvent e)

void	mouseEvent (MouseEvent event)

void	pre ()

void	setFocus (boolean focus)

void	setFont (Font font)

void	setLocalColorScheme (int cs)

void	setMaxWordLength (int ml)

void	setTabManager (GTabManager tm)

void	setVisibleChar (char c)

Public Member Functions inherited from g4p_controls.GAbstractControl
void	addControl (GAbstractControl c)

void	addControl (GAbstractControl c, float x, float y)

void	addControl (GAbstractControl c, float x, float y, float angle)

void	addControls (GAbstractControl... controls)

void	addEventHandler (Object obj, String methodName)

void	dispose ()

void	draw ()

void	forceBufferUpdate ()

	GAbstractControl (PApplet theApplet)

	GAbstractControl (PApplet theApplet, float p0, float p1)

	GAbstractControl (PApplet theApplet, float p0, float p1, float p2, float p3)

int	getAlpha ()

int	getCursorOver ()

float	getCX ()

float	getCY ()

float	getHeight ()

int	getLocalColorScheme ()

PApplet	getPApplet ()

GAbstractControl	getParent ()

float	getRotation ()

PGraphics	getSnapshot ()

GToolTip	getTip ()

float	getWidth ()

float	getX ()

float	getY ()

boolean	hasFocus ()

boolean	isDragging ()

boolean	isEnabled ()

boolean	isOpaque ()

boolean	isVisible ()

void	keyEvent (KeyEvent e)

void	mouseEvent (MouseEvent event)

void	moveTo (float px, float py)

void	moveTo (float px, float py, GControlMode mode)

void	post ()

void	pre ()

void	removeTip ()

boolean	saveSnapshot ()

boolean	saveSnapshot (String filename)

void	setAlpha (int alpha)

void	setAlpha (int alpha, boolean includeChildren)

void	setCursorOver (int cursorOver)

void	setEnabled (boolean enable)

void	setFocus (boolean focus)

void	setLocalColor (int colorNo, int color)

void	setLocalColorScheme (int cs)

void	setLocalColorScheme (int cs, boolean includeChildren)

void	setOpaque (boolean opaque)

void	setRotation (float angle)

void	setRotation (float angle, GControlMode mode)

void	setTip (GToolTip tt, float offset, float angle)

void	setTip (GToolTip tt, GAlign ax, GAlign ay, float gap)

void	setTip (String text, float offset, float angle)

void	setTip (String text, GAlign ax, GAlign ay, float gap)

void	setTipDisplayTime (long msecs)

void	setTipEnabled (boolean enable)

void	setTipHorz (boolean level)

void	setTipPos (float radius, float ang)

void	setTipPos (GAlign ax, GAlign ay, float gap)

void	setTipText (String text)

void	setVisible (boolean visible)

String	toString ()

void	setTabManager (GTabManager tm)

Protected Member Functions
void	calculateCaretPos (TextLayoutHitInfo tlhi)

boolean	changeText ()

void	keyPressedProcess (int keyCode, char keyChar, boolean X, boolean ctrlDown)

void	keyTypedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)

void	loseFocus (GAbstractControl grabber)

boolean	moveCaretEndOfLine (TextLayoutHitInfo currPos)

boolean	moveCaretLeft (TextLayoutHitInfo currPos)

boolean	moveCaretRight (TextLayoutHitInfo currPos)

boolean	moveCaretStartOfLine (TextLayoutHitInfo currPos)

void	takeFocus ()

void	updateBuffer ()

Protected Member Functions inherited from g4p_controls.GAbstractControl
void	addControlImpl (GAbstractControl c, float x, float y, float angle)

void	addToParent (GAbstractControl p)

void	calcTransformedOrigin (float px, float py)

boolean	controlSupportsToolTips ()

void	createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)

void	drawChildren ()

void	fireEvent (Object... objects)

int	focusObjectZ ()

PGraphics	getBuffer ()

int	getCurrHotSpot ()

AffineTransform	getTransform (AffineTransform aff)

void	hideTip ()

boolean	isAvailable ()

boolean	isDisplayable (int ascii)

boolean	isSuitableForGroupControl (GAbstractControl control)

void	loseFocus (GAbstractControl grabber)

void	makeBuffer ()

void	manageToolTip ()

void	resize (int w, int h)

void	resize (int w, int h, GControlMode mode)

void	setAvailable (boolean avail)

void	setZ (int parentZ)

void	showTip ()

void	takeFocus ()

void	updateBuffer ()

int	whichHotSpot (float px, float py)

Protected Attributes
int	adjust = 0

GTimer	caretFlasher

float	caretX

float	caretY

TextLayoutHitInfo	cursorTLHI = new TextLayoutHitInfo()

int	endChar = -1

TextLayoutHitInfo	endTLHI = new TextLayoutHitInfo()

GeneralPath	gpTextDisplayArea

boolean	keepCursorInView = false

Font	localFont = G4P.inputFont

int	nbr = 0

int	pos = endChar

float	ptx

float	pty

boolean	showCaret = false

int	startChar = -1

TextLayoutHitInfo	startTLHI = new TextLayoutHitInfo()

boolean	textChanged = false

float	th

float	tw

float	tx

float	ty

int	wrapWidth = Integer.MAX_VALUE

Protected Attributes inherited from g4p_controls.GAbstractControl
boolean	allowChildren = true

boolean	allowToolTips = true

int	alphaLevel = G4P.globalAlpha

boolean	available = true

PGraphicsJava2D	buffer = null

boolean	bufferInvalid = true

LinkedList< GAbstractControl >	children = null

int	currSpot = -1

int	cursorOver = HAND

float	cx

float	cy

boolean	dragging = false

boolean	enabled = true

Method	eventHandlerMethod = null

String	eventHandlerMethodName

Object	eventHandlerObject = null

float	halfHeight

float	halfWidth

float	height

HotSpot[]	hotspots = null

int	lastSpot = -1

int	localColorScheme = G4P.globalColorScheme

boolean	opaque = false

float	ox

float	oy

Color[]	palette = null

GAbstractControl	parent = null

int	registeredMethods = 0

float	rotAngle

double[]	temp = new double[2]

GToolTip	tip = null

boolean	visible = true

float	width

PApplet	winApp

float	x

float	y

int	z = Z_STICKY

Additional Inherited Members
Public Attributes inherited from g4p_controls.GAbstractControl
String	tag = ""

int	tagNo

Public Attributes inherited from g4p_controls.GConstants
int	ALPHA_BLOCK = 128

int	ALPHA_PICK = 48

TextAttribute	BACKGROUND = TextAttribute.BACKGROUND

int	BLUE_SCHEME = 6

int	BOLD = Font.BOLD

int	CANCEL = JOptionPane.CANCEL_OPTION

int	CLOSE_WINDOW = 0x00000f02

int	CLOSED = JOptionPane.CLOSED_OPTION

int	CTRL_ANGULAR = 0x00000501

int	CTRL_HORIZONTAL = 0x00000502

int	CTRL_VERTICAL = 0x00000503

int	CYAN_SCHEME = 5

int	DECIMAL = 1

char	END = java.awt.event.KeyEvent.VK_END

int	ERROR_MESSAGE = JOptionPane.ERROR_MESSAGE

int	EXIT_APP = 0x00000f01

int	EXPONENT = 2

TextAttribute	FAMILY = TextAttribute.FAMILY

TextAttribute	FOREGROUND = TextAttribute.FOREGROUND

int	FORWARD = 1

int	GOLD_SCHEME = 7

int	GREEN_SCHEME = 1

int	HIDE_WINDOW = 0x00000f04

char	HOME = java.awt.event.KeyEvent.VK_HOME

int	INFO_MESSAGE = JOptionPane.INFORMATION_MESSAGE

int	INTEGER = 0

int	ITALIC = Font.ITALIC

int	KEEP_OPEN = 0x00000f03

int	NO = JOptionPane.NO_OPTION

int	OK = JOptionPane.OK_OPTION

int	OK_CANCEL = JOptionPane.OK_CANCEL_OPTION

int	ORANGE_SCHEME = 4

int	ORIENT_LEFT = -1

int	ORIENT_RIGHT = 1

int	ORIENT_TRACK = 0

int	PLAIN = Font.PLAIN

int	PLAIN_MESSAGE = JOptionPane.PLAIN_MESSAGE

TextAttribute	POSTURE = TextAttribute.POSTURE

Float	POSTURE_OBLIQUE = new Float(0.20f)

Float	POSTURE_REGULAR = new Float(0.0f)

int	PURPLE_SCHEME = 3

int	QUERY_MESSAGE = JOptionPane.QUESTION_MESSAGE

int	RED_SCHEME = 0

int	REVERSE = -1

int	SCHEME_10 = 10

int	SCHEME_11 = 11

int	SCHEME_12 = 12

int	SCHEME_13 = 13

int	SCHEME_14 = 14

int	SCHEME_15 = 15

int	SCHEME_8 = 8

int	SCHEME_9 = 9

int	SCROLLBARS_AUTOHIDE = 0x1000

int	SCROLLBARS_BOTH = 0x0003

int	SCROLLBARS_HORIZONTAL_ONLY = 0x0002

int	SCROLLBARS_NONE = 0x0000

int	SCROLLBARS_VERTICAL_ONLY = 0x0001

TextAttribute	SIZE = TextAttribute.SIZE

TextAttribute	STRIKETHROUGH = TextAttribute.STRIKETHROUGH

Boolean	STRIKETHROUGH_OFF = new Boolean(false)

Boolean	STRIKETHROUGH_ON = new Boolean(true)

TextAttribute	SUPERSCRIPT = TextAttribute.SUPERSCRIPT

Integer	SUPERSCRIPT_OFF = new Integer(0)

Integer	SUPERSCRIPT_SUB = new Integer(-1)

Integer	SUPERSCRIPT_SUPER = new Integer(1)

int	UNDEFINED = Integer.MAX_VALUE

TextAttribute	UNDERLINE = TextAttribute.UNDERLINE

int	UNDERLINE_OFF = Integer.valueOf(-1)

int	UNDERLINE_ON = TextAttribute.UNDERLINE_ON

int	USER_COL_SCHEME = 0x00010102

int	WARN_MESSAGE = JOptionPane.WARNING_MESSAGE

TextAttribute	WEIGHT = TextAttribute.WEIGHT

Float	WEIGHT_BOLD = new Float(2.0f)

Float	WEIGHT_DEMIBOLD = new Float(1.75f)

Float	WEIGHT_DEMILIGHT = new Float(0.875f)

Float	WEIGHT_EXTRA_LIGHT = new Float(0.5f)

Float	WEIGHT_EXTRABOLD = new Float(2.5f)

Float	WEIGHT_HEAVY = new Float(2.25f)

Float	WEIGHT_LIGHT = new Float(0.75f)

Float	WEIGHT_MEDIUM = new Float(1.5f)

Float	WEIGHT_REGULAR = new Float(1.0f)

Float	WEIGHT_SEMIBOLD = new Float(1.25f)

Float	WEIGHT_ULTRABOLD = new Float(2.75f)

TextAttribute	WIDTH = TextAttribute.WIDTH

Float	WIDTH_CONDENSED = new Float(0.75f)

Float	WIDTH_EXTENDED = new Float(1.5f)

Float	WIDTH_REGULAR = new Float(1.0f)

Float	WIDTH_SEMI_CONDENSED = new Float(0.875f)

Float	WIDTH_SEMI_EXTENDED = new Float(1.25f)

int	X4 = 1

int	X8 = 2

int	YELLOW_SCHEME = 2

int	YES = JOptionPane.YES_OPTION

int	YES_NO = JOptionPane.YES_NO_OPTION

int	YES_NO_CANCEL = JOptionPane.YES_NO_CANCEL_OPTION

Static Protected Attributes inherited from g4p_controls.GAbstractControl
static GAbstractControl	controlToTakeFocus = null

static GAbstractControl	cursorIsOver

static float	epsilon = 0.001f

static GAbstractControl	focusIsWith = null

Detailed Description

The password field component.

This control allows the user to secretly enter a password and supports an optional horizontal scrollbar.

Each key typed will display a # character, but the user can specify another character.

Unlike a text field it does not support text selection or the copying and pasting of text via the clipboard.

Fires CHANGED, ENTERED, LOST_FOCUS, GETS_FOCUS events.
The focus events are only fired if the control is added to a GTabManager object.

Author: Peter Lager

Constructor & Destructor Documentation

◆ GPassword() [1/2]

g4p_controls.GPassword.GPassword	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3
	)

Create a password field without a scrollbar.

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode

◆ GPassword() [2/2]

g4p_controls.GPassword.GPassword	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3,
		int	sbPolicy
	)

Create a password field with the given scrollbar policy.
This policy can be one of these

SCROLLBARS_NONE
SCROLLBARS_HORIZONTAL_ONLY

If you want the scrollbar to auto hide then perform a logical or with

SCROLLBARS_AUTOHIDE

e.g. SCROLLBARS_HORIZONTAL_ONLY | SCROLLBARS_AUTOHIDE

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode
sbPolicy	scrollbar policy

Member Function Documentation

◆ calculateCaretPos()

void g4p_controls.GPassword.calculateCaretPos ( TextLayoutHitInfo tlhi )

protected

Calculate the caret (text insertion point)

Parameters

tlhi

◆ draw()

void g4p_controls.GPassword.draw ( )

Reimplemented from g4p_controls.GAbstractControl.

◆ getPassword()

String g4p_controls.GPassword.getPassword ( )

Get the current password (hidden) value of this field.

Returns: actual password text

◆ getSnapshot()

PGraphics g4p_controls.GPassword.getSnapshot ( )

This method should be used sparingly since it is heavy on resources.

Returns: a PGraphics object showing current state of the control (ignoring rotation)

Reimplemented from g4p_controls.GAbstractControl.

◆ getWordLength()

int g4p_controls.GPassword.getWordLength ( )

Returns: the current length of the password entered.

◆ keyEvent()

void g4p_controls.GPassword.keyEvent ( KeyEvent e )

Reimplemented from g4p_controls.GAbstractControl.

◆ loseFocus()

void g4p_controls.GPassword.loseFocus ( GAbstractControl grabber )

protected

Give up focus but if the text is only made from spaces then set it to null text.
Fire focus events for the GTextField and GTextArea controls

Reimplemented from g4p_controls.GAbstractControl.

◆ mouseEvent()

void g4p_controls.GPassword.mouseEvent ( MouseEvent event )

Reimplemented from g4p_controls.GAbstractControl.

◆ moveCaretEndOfLine()

boolean g4p_controls.GPassword.moveCaretEndOfLine ( TextLayoutHitInfo currPos )

protected

Move caret to the end of the line that has the current caret position

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

◆ moveCaretLeft()

boolean g4p_controls.GPassword.moveCaretLeft ( TextLayoutHitInfo currPos )

protected

Move caret left by one character.

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

◆ moveCaretRight()

boolean g4p_controls.GPassword.moveCaretRight ( TextLayoutHitInfo currPos )

protected

Move caret right by one character.

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

◆ moveCaretStartOfLine()

boolean g4p_controls.GPassword.moveCaretStartOfLine ( TextLayoutHitInfo currPos )

protected

Move caret to home position

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

◆ pre()

void g4p_controls.GPassword.pre ( )

Reimplemented from g4p_controls.GAbstractControl.

◆ setFocus()

void g4p_controls.GPassword.setFocus ( boolean focus )

Determines whether this component is to have focus or not.

Reimplemented from g4p_controls.GAbstractControl.

◆ setFont()

void g4p_controls.GPassword.setFont ( Font font )

Set the font to be used in this control

Parameters

font	AWT font to use

◆ setLocalColorScheme()

void g4p_controls.GPassword.setLocalColorScheme ( int cs )

Sets the local colour scheme for this control

Reimplemented from g4p_controls.GAbstractControl.

◆ setMaxWordLength()

void g4p_controls.GPassword.setMaxWordLength ( int ml )

Sets the max length of the password. This method is ignored if the control already holds some user input.
The default value is 10.

Parameters

ml	the new max length (must be ≥ 1)

◆ setTabManager()

void g4p_controls.GPassword.setTabManager ( GTabManager tm )

Implements g4p_controls.Focusable.

◆ setVisibleChar()

void g4p_controls.GPassword.setVisibleChar ( char c )

Set the character that will be displayed instead of the actual character entered by the user.

Parameters

c	the character to use instead of plain text. The default value is '#'

◆ takeFocus()

void g4p_controls.GPassword.takeFocus ( )

protected

Give the focus to this component but only after allowing the current component with focus to release it gracefully.
Always cancel the keyFocusIsWith irrespective of the component type. Fire focus events for the GTextField and GTextArea controls

Reimplemented from g4p_controls.GAbstractControl.

◆ updateBuffer()

void g4p_controls.GPassword.updateBuffer ( )

protected

If the buffer is invalid then redraw it.

@TODO need to use palette for colours

Reimplemented from g4p_controls.GAbstractControl.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GPassword() [1/2]

◆ GPassword() [2/2]

Member Function Documentation

◆ calculateCaretPos()

◆ draw()

◆ getPassword()

◆ getSnapshot()

◆ getWordLength()

◆ keyEvent()

◆ loseFocus()

◆ mouseEvent()

◆ moveCaretEndOfLine()

◆ moveCaretLeft()

◆ moveCaretRight()

◆ moveCaretStartOfLine()

◆ pre()

◆ setFocus()

◆ setFont()

◆ setLocalColorScheme()

◆ setMaxWordLength()

◆ setTabManager()

◆ setVisibleChar()

◆ takeFocus()

◆ updateBuffer()