class InputField in Tinman.AddOns.GUI.Components

A text input field.

class	InputField	extends	Component
		implements	ITextProperty
		base of	InputFieldGeneric

Remarks

The following default Layout settings are defined for InputField objects:

• LayoutMargin: 2
• LayoutGrow: Horizontal
• LayoutFill: Horizontal

Public / Constants

Class

The style class for InputField s.

public static readonly field	Class
type	StyleClass

Public / Attributes

Action

The input click of the default action of this component.

public property	Action { get set }
type	InputClick
value		The input click or None.
inherited	Component.Action

Remarks:

Defaults to None.

Bounds

Returns the bounds of this component in the client area of its parent container.

public property	Bounds { get }
type	Box2I
value		The component bounds.
inherited	Component.Bounds

Cursor

public property	Cursor { get }
type	int32
value

Editable

public property	Editable { get set }
type	bool
value

Focusable

Can this component receive the input focus?

public property	Focusable { get set }
type	bool
value		true if the component can receive the input focus, false if not.
inherited	Component.Focusable

HasSelection

public property	HasSelection { get }
type	bool
value

Height

Height of this component in its parent containers client area.

public property	Height { get }
type	int32
value		The current component height, in pixels.
inherited	Component.Height

IsFocussed

Does this component has the input focus?

public virtual property	IsFocussed { get }
type	bool
value		true if this component has the input focus, false if not.
inherited	Component.IsFocussed

IsHighlighted

public property	IsHighlighted { get }
type	bool
value
inherited	Component.IsHighlighted

IsHovered

Does the mouse cursor currently hover above this component?

public property	IsHovered { get }
type	bool
value		true if the mouse cursor hovers above this component, false if not.
inherited	Component.IsHovered

LayoutAlign

The alignment anchor of this component.

public property	LayoutAlign { get set }
type	Anchor
value		The anchor.
inherited	Component.LayoutAlign

LayoutDefault

Returns the default Layout settings for this component.

public override property	LayoutDefault { get }
type	Layout
value		The default layout settings.
overrides	Component.LayoutDefault

Remarks:

The default implementation returns Default.

LayoutFill

The fill mode of this component.

public virtual property	LayoutFill { get set }
type	Axis
value		The fill mode.
inherited	Component.LayoutFill

LayoutGrid

The bounds of this component in its parent containers layout grid.

public property	LayoutGrid { get set }
type	Box2I
value		The layout grid bounds.
inherited	Component.LayoutGrid

LayoutGrow

Defines how the layout grid column resp. row in the components parent container grows.

public property	LayoutGrow { get set }
type	Axis
value		The axes that will grow.
inherited	Component.LayoutGrow

LayoutInfo

The current layout settings of this component.

public virtual property	LayoutInfo { get set }
type	Layout
value		The Layout info object.
inherited	Component.LayoutInfo

LayoutMargin

The outer margin of this component.

public property	LayoutMargin { get set }
type	Edging
value		The outer margin.
inherited	Component.LayoutMargin

LayoutShrink

Defines how the layout grid column resp. row in the components parent container grows.

public property	LayoutShrink { get set }
type	Axis
value		The axes that will shrink.
inherited	Component.LayoutShrink

LayoutSize

The requested size of this component, in pixels.

public property	LayoutSize { get set }
type	Vec2I
value		The requested size.
inherited	Component.LayoutSize

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

OnAction

The components default action has been triggered.

public property	OnAction { get }
type	IEventGeneric<Component>
value	[not-null]	The event object.
inherited	Component.OnAction

Parent

The parent container of this component.

public property	Parent { get }
type	Container
value		The parent container or null if this component is the root.
inherited	Component.Parent

ParentCorners

Returns the corners that this component shares with the client area of its parent container.

public property	ParentCorners { get }
type	Corner
value		The shared client area corners.
inherited	Component.ParentCorners

ParentEdges

Returns the edges that this component shares with the client area of its parent container.

public property	ParentEdges { get }
type	Anchor
value		The shared client area edges.
inherited	Component.ParentEdges

Prompt

public property	Prompt { get set }
type	string
value

ScrollHeight

Scroll height of this component.

public property	ScrollHeight { get }
type	int32
value		The current scroll height, in pixels.
inherited	Component.ScrollHeight

ScrollTick

Returns the size of a single scroll tick.

public virtual property	ScrollTick { get }
type	int32
value		The scroll tick size, in pixels.
inherited	Component.ScrollTick

ScrollWidth

Scroll width of this component.

public property	ScrollWidth { get }
type	int32
value		The current scroll width, in pixels.
inherited	Component.ScrollWidth

ScrollX

The horizontal scroll position of this component.

public property	ScrollX { get set }
type	int32
value		The current scroll position.
inherited	Component.ScrollX

ScrollY

The vertical scroll position of this component.

public property	ScrollY { get set }
type	int32
value		The current scroll position.
inherited	Component.ScrollY

SelectionRange

public property	SelectionRange { get }
type	RangeI
value

SelectionText

public property	SelectionText { get set }
type	string
value

State

The component state.

public virtual property	State { get set }
type	ComponentState
value		The component state.
inherited	Component.State

StyleClassType

Returns the style class for this component type.

public override property	StyleClassType { get }
type	StyleClass
value		The style class (e.g. 'InputField' for InputField).
implements	Component.StyleClassType

StyleClassVariant

Optional style class variant of this component.

public property	StyleClassVariant { get set }
type	string
value		The variant name or null.
inherited	Component.StyleClassVariant

Stylesheet

The stylesheet object to use for this user interface element.

public property	Stylesheet { get set }
type	Stylesheet
value		The stylesheet object to use or null.
inherited	Component.Stylesheet

Tag

The user-defined tag value of this component.

public property	Tag { get set }
type	int32
value		The tag value or null.
inherited	Component.Tag

Remarks:

Defaults to -1.

Text

The text value.

public property	Text { get set }
type	string
value		The text value. Will be replaced with the empty string when null.
implements	ITextProperty.Text

Remarks:

Defaults to the empty string ''.

See also:

StringUtil.IsEmptyOrWhitespace

Width

Width of this component in its parent containers client area.

public property	Width { get }
type	int32
value		The current component width, in pixels.
inherited	Component.Width

Public / Constructors

InputField

Creates a new instance of InputField.

public constructor	InputField (bool editable = true, string prompt = null)
params	editable		Initial value for Editable. Defaults to true.
	prompt		Initial value for Prompt. Defaults to null.

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

ClearSelection

public method

ClearSelection ()

ConsumeInput

Consumes the given user input event.

public method	ConsumeInput (InputEvent inputEvent)
type	bool
params	inputEvent		The user input event.
returns			true if the input event has been consumed, false if not.
inherited	Component.ConsumeInput

Remarks:

Input events are provided to an IInputConsumer object only if it has the input focus (see FocusGained and FocusLost). Mouse events are provided when the mouse cursor is inside of the input bounds (MouseEnter and MouseLeave). The Closing event can be provided at any time.

1. FocusGained: gained input focus
2. Keyboard events:
   • Pressed: key has been pressed down.
   • Released: key has been released.
   • Clicked: key has been clicked.
   • Character: a character has been typed.
3. Mouse events:
   1. MouseEnter
   2. Mouse events:
      • Pressed
      • Released
      • Clicked
      • MouseMove
   3. MouseLeave
4. FocusLost: lost input focus
5. Closing: user request to shut down

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Focus

Transfers the input focus to this component.

public method	Focus ()
returns		[not-null]	this
inherited	Component.Focus

GraphicsAttach

Attaches this component to the given Graphics context.

public virtual method	GraphicsAttach (Graphics graphics)
params	graphics	[not-null]	The graphics context.
inherited	Component.GraphicsAttach

Remarks:

All graphics-related resources should be created here.

GraphicsDetach

Detaches this user interface component from its Graphics context.

public virtual method	GraphicsDetach ()
inherited	Component.GraphicsDetach

Remarks:

All graphics-related resources should be disposed here.

GraphicsResize

The screen size has changed.

public virtual method	GraphicsResize (Vec2I screenSize)
params	screenSize		The new screen size, in pixels.
inherited	Component.GraphicsResize

Remarks:

The given screen size is equal to the value of ScreenSize of the Graphics object that has been passed to GraphicsAttach earlier.

MoveCursor

public method	MoveCursor (int32 index, bool selecting = false)
params	index
	selecting

Render2D

Performs 2D rendering.

public method	Render2D (Graphics g)
params	g	[not-null]	The graphics object to use.
inherited	Component.Render2D

Remarks:

When this method is called, the given Graphics object has already been initialized for 2D rendering:

• The render bounds have been specified (see Bounds).
• The Begin method has already been called.
• Clipping and translation have been applied, so that (0|0) refers to the top-left pixel of the target rectangle and ScreenSize returns the target rectangle size. The target rectangle and the clipping rectangle can be different.

Usually, Render2D is called from within Render.

Selection

public method	Selection (int32 start = 0, int32 end = Maths.MaxInt)
params	start
	end

UpdateFrameTime

This method is called once per application frame.

public override method	UpdateFrameTime (float32 time)
type	bool
params	time	[>0]	The amount of time that has elapsed since the last frame, in seconds.
returns			true if the object needs to be presented again, false if the current presentation is still valid.
overrides	Component.UpdateFrameTime

Protected / Attributes

ActualLayoutMargin

Returns the actual margin of this component.

protected property	ActualLayoutMargin { get }
type	Edging
value		The actual margin value.
inherited	Component.ActualLayoutMargin

Remarks:

The default implementation returns LayoutMargin. Implementing subclasses can perform additional computations here.

Subclasses must call InvalidateLayout with ComputeLayoutGridExtend to notify when ActualLayoutMargin returns a different value.

ActualLayoutSize

Returns the actual minimum layout size of this component.

protected override property	ActualLayoutSize { get }
type	Vec2I
value		The actual minimum layout size.
overrides	Component.ActualLayoutSize

Remarks:

The default implementation returns LayoutSize. Implementing subclasses can perform additional computations here.

Subclasses must call InvalidateLayout with ComputeLayoutGridExtend to notify when ActualLayoutSize returns a different value.

color

The current color scheme.

protected field	color
type	ColorScheme
inherited	Component.color

graphics

The current Graphics object or null if this component is not attached.

protected field	graphics
type	Graphics
inherited	Component.graphics

IsAttached

Is this component currently attached to a live component hierarchy?

protected property	IsAttached { get }
type	bool
value		true if this component is attached to a live hierarchy, false if not.
inherited	Component.IsAttached

textFont

The TextFont value for this component.

[Owner]
protected field	textFont
type	PixelFont
inherited	Component.textFont

textFontHint

The TextFontHint value for this component.

[Owner]
protected field	textFontHint
type	PixelFont
inherited	Component.textFontHint

Protected / Methods

ActionClick

The action click has been performed.

protected virtual method	ActionClick ()
inherited	Component.ActionClick

See also:

Component.Action

ActionNotify

Notifies all listeners of the OnAction event.

protected method	ActionNotify (bool flash = true)
params	flash		Render a visual flash to indicate the action? Defaults to true.
inherited	Component.ActionNotify

BoundsChanged

This method is called each time the Bounds of this component have changed.

[EmptyBody]
protected virtual method	BoundsChanged ()
inherited	Component.BoundsChanged

ConsumeAction

protected virtual method	ConsumeAction (InputEvent action)
type	bool
params	action
inherited	Component.ConsumeAction

ConsumeKeyboard

Processes the given input event.

[EmptyBody]
protected override method	ConsumeKeyboard (InputEvent key)
type	bool
params	key		The mouse event.
returns			true if the component has consumed the input event, false if not.
overrides	Component.ConsumeKeyboard

ConsumeMouse

Processes the given input event.

protected override method	ConsumeMouse (InputEvent mouse)
type	bool
params	mouse		The mouse event.
returns			true if the component has consumed the input event, false if not.
overrides	Component.ConsumeMouse

Dirty

protected method	Dirty ()
inherited	Component.Dirty

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Component.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.

DoRender

Performs component specific rendering.

[EmptyBody]
protected override method	DoRender (Graphics graphics)
params	graphics		The Graphics object to use.
overrides	Component.DoRender

DoStylesheetApply

Applies the current stylesheet settings to this component.

protected virtual method	DoStylesheetApply ()
inherited	Component.DoStylesheetApply

Remarks:

Implementing methods should query fetch style property values and store them somewhere for using them later quickly.

All graphics resources that are acquired during DoStylesheetApply must be properly disposed in GraphicsDetach.

DrawBackground

Draws the background rectangle of this component.

protected method	DrawBackground (bool border, int32 round = 5)
params	border		Draw a border?
	round		Size of round corners. Defaults to 5.
inherited	Component.DrawBackground

DrawHint

Draws a hint text.

protected method	DrawHint (string text, int32 x, int32 y, Anchor anchor)
params	text		The hint text.
	x		X-coordinate of anchor point.
	y		Y-coordinate of anchor point.
	anchor		The text anchor point.
inherited	Component.DrawHint

DrawString

Draws a text.

protected method	DrawString (string text, int32 x, int32 y, Anchor anchor)
params	text		The text.
	x		X-coordinate of anchor point.
	y		Y-coordinate of anchor point.
	anchor		The text anchor point.
inherited	Component.DrawString

FocusChanged

This method is called when this component has lost or gained the input focus.

[EmptyBody]
protected virtual method	FocusChanged ()
inherited	Component.FocusChanged

InvalidateLayout

Invalidates the layout grid of the parent container of this component.

protected method	InvalidateLayout (LayoutAction layoutAction = LayoutAction.ComputeLayoutGridExtend)
params	layoutAction		The layout action that needs to be performed. Defaults to ComputeLayoutGridExtend.
inherited	Component.InvalidateLayout

TextChanged

This method is called each time the Text value has changed.

[EmptyBody]
protected virtual method	TextChanged ()