Class CvsTextField

This class supports a single line text entry field.

The user must ensure that the field is wide enough for the maximum length of text expected. This control stops accepting input if it is likely to exceed the control width.

The left/right arrow keys move the text insertion point within the text. Used in combination with the shift key enables part or all of the text to be selected.

If no text is selected then the arrows keys can move off the current control to another. This only works if each textfield has a unique index number.

If the control has the index value 'idx' then the next control depends on the arrow key pressed -
left : idx - 1
right : idx + 1
up : idx - offset
down : idx + offset

The offset value is set when initialising the idx value with the index(idx, deltaIndex method.)

No other controls can be used while a textfield control is active. Pressing 'Enter' or attempting to move to a non-existant textfield deactivates the current text field.

The user can provide their own validation function which is checked when the control is deativated.

Since

0.9.3

Hierarchy

CvsText
- CvsTextField

Properties

`Protected` _clock

_clock: number

`Protected` _currCsrIdx

_currCsrIdx: number = 0

`Protected` _cursorOn

_cursorOn: boolean = false

`Protected` _linkIndex

_linkIndex: number

`Protected` _linkOffset

_linkOffset: number = 0

`Protected` _prevCsrIdx

_prevCsrIdx: number = 0

`Protected` _textInvalid

_textInvalid: boolean = false

`Protected` _validation

_validation: Function

action

action: Function = ...

The event handler for this control. Although it is permitted to set this property directly it is recommended that the setAction(...) method is used to define the event handler actions.

Methods

_activateNext

_activateNext(offset: number): void
Called when this control passes focus to a new control.
Parameters
- offset: number
Returns void
- Defined in index.ts:6631

addChild

addChild(c: string | CvsBaseControl, rx?: number, ry?: number): any
Add a child to this control using its relative position [rx, ry]. If rx and ry are not provided then it uses the values set in the child.

Returns
this control
Parameters
- c: string | CvsBaseControl
  
  is the actual control or its name
- Optional rx: number
- Optional ry: number
Returns any
Inherited from CvsText.addChild
- Defined in index.ts:3796

clearValid

clearValid(): CvsTextField
Clears the validity flag irrespective of whether the text is valid or not.

Returns
this control

Returns CvsTextField
- Defined in index.ts:6561

corners

corners(c: number[]): number[] | CvsBaseControl
Set or get the corner radii used for this control

Returns
an array with the 4 corner radii
Parameters
- c: number[]
  
  an array of 4 corner radii
Returns number[] | CvsBaseControl
Inherited from CvsText.corners
- Defined in index.ts:4227

disable

disable(cascade?: boolean): CvsBaseControl
Disables this control

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true disable child controls
Returns CvsBaseControl
Inherited from CvsText.disable
- Defined in index.ts:3941

enable

enable(cascade?: boolean): CvsBaseControl
Enables this control

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true enable child controls
Returns CvsBaseControl
Inherited from CvsText.enable
- Defined in index.ts:3924

getAbsXY

getAbsXY(): __Position
Calculates the absolute position on the canvas taking into account any ancestors

Returns
the actual position in the canvas

Returns __Position
Inherited from CvsText.getAbsXY
- Defined in index.ts:3747

getParent

getParent(): CvsPane | CvsBaseControl
Returns
this controls parent

Returns CvsPane | CvsBaseControl
Inherited from CvsText.getParent
- Defined in index.ts:3850

hasValidText

hasValidText(): boolean
If there is no text then this method will always return false. If there is some text then this method returns the same as the isValid() method.

Returns
true if there is some text and it passed any validation function

Returns boolean
- Defined in index.ts:6552

hide

hide(cascade?: boolean): CvsBaseControl
Make this control invisible

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true hide children
Returns CvsBaseControl
Inherited from CvsText.hide
- Defined in index.ts:3970

index

index(idx: number, deltaIndex?: number): CvsTextField
Set a unique index number for this text field.

Returns
this control
Parameters
- idx: number
  
  unique index number
- Optional deltaIndex: number
  
  relative link when using up/down arrow keys
Returns CvsTextField
- Defined in index.ts:6472

invalidateBuffer

invalidateBuffer(): CvsTextField
Invalidates the control's buffer forcing it to validate it on the next frame

Returns
this control

Returns CvsTextField
Inherited from CvsText.invalidateBuffer
- Defined in index.ts:4091

isEnabled

isEnabled(): boolean
Use enable() and disable() to enable and disable it.

Returns
true if the control is enabled else false

Returns boolean
Inherited from CvsText.isEnabled
- Defined in index.ts:3915

isValid

isValid(): boolean
If there is no validation function then this will always return true.

Returns
true if the text has passed validation

Returns boolean
- Defined in index.ts:6542

isVisible

isVisible(): boolean
Returns
true if this control is visible

Since
0.9.3

Returns boolean
Inherited from CvsText.isVisible
- Defined in index.ts:3982

leaveParent

leaveParent(): CvsBaseControl
Remove this control from its parent

Returns
this control

Returns CvsBaseControl
Inherited from CvsText.leaveParent
- Defined in index.ts:3840

name

name(): string
Returns
the unique identier for this control

Returns string
Inherited from CvsText.name
- Defined in index.ts:3738

noIndex

noIndex(): CvsTextField
Deletes the index number.

Returns
this control

Returns CvsTextField
- Defined in index.ts:6531

noText

noText(): CvsBaseControl
Renoves any text that the control might use ti display itself.

Returns
this control

Returns CvsBaseControl
Inherited from CvsText.noText
- Defined in index.ts:4828

opaque

opaque(): CvsBaseControl
Makes the controls background opaque. The actual color depends on the controls color scheme

Returns
this control

Returns CvsBaseControl
Inherited from CvsText.opaque
- Defined in index.ts:3991

orient

orient(dir: string): CvsBaseControl
Specify the orientation to show this control

Returns
this control
Parameters
- dir: string
  
  'north', 'south', 'east' or 'west'
Returns CvsBaseControl
Inherited from CvsText.orient
- Defined in index.ts:3881

parent

parent(p: string | CvsBaseControl, rx?: number, ry?: number): CvsBaseControl
Adds this control to another control which becomes its parent

Returns
this control
Parameters
- p: string | CvsBaseControl
  
  is the parental control or its name
- Optional rx: number
  
  x position relative to parent
- Optional ry: number
  
  y position relative to parent
Returns CvsBaseControl
Inherited from CvsText.parent
- Defined in index.ts:3784

removeChild

removeChild(c: string | CvsBaseControl): CvsTextField
Remove a child control from this one so that it stays in same screen position

Returns
this control
Parameters
- c: string | CvsBaseControl
  
  the control to remove or its name
Returns CvsTextField
Inherited from CvsText.removeChild
- Defined in index.ts:3818

scheme

scheme(id?: string, cascade?: boolean): CvsBaseControl | __Scheme
Sets or gets the color scheme used by this control.

Returns
this control or the control's color scheme
Parameters
- Optional id: string
- Optional cascade: boolean
Returns CvsBaseControl | __Scheme
Inherited from CvsText.scheme
- Defined in index.ts:3763

setAction

setAction(event_handler: Function): CvsTextField
This sets the event handler to be used when this control fires an event. The parameter can take three forms:
1. Arrow function definition
2. Anonymous function definition
3. Named function declaration
Returns
this control
Parameters
- event_handler: Function
  
  the function to handle this controls event
Returns CvsTextField
Inherited from CvsText.setAction
- Defined in index.ts:3866

show

show(cascade?: boolean): CvsBaseControl
Make this control visible

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true show children
Returns CvsBaseControl
Inherited from CvsText.show
- Defined in index.ts:3957

shrink

shrink(dim?: string): CvsBaseControl
Shrink the control to fit contents.

To shrink on one dimension only pass either 'w' (width) or 'h' (height) to indicate which dimmension to shrink

Returns
this control
Parameters
- Optional dim: string
  
  the dimension to shrink
Returns CvsBaseControl
Inherited from CvsText.shrink
- Defined in index.ts:4012

text

text(t?: string): string | CvsTextField
Gets or sets the current text. Any EOL characters are stripped out of the string. If necessary the string length will be reduced until will fit inside the textfiel. If a validation function has been set then the string will be validated.

Returns
this control for setter
Parameters
- Optional t: string
  
  a string representing text to display
Returns string | CvsTextField
Overrides CvsText.text
- Defined in index.ts:6493

textAlign

textAlign(align: number): CvsBaseControl
Sets the text alignment.

Processing constants are used to define the text alignment.

Returns
this control
Parameters
- align: number
  
  LEFT, CENTER or RIGHT
Returns CvsBaseControl
Inherited from CvsText.textAlign
- Defined in index.ts:4815

tipTextSize

tipTextSize(tsize?: number): CvsTextField
Sets the size of the text to use in the tooltip
Parameters
- Optional tsize: number
  
  text size for this tooltip
Returns CvsTextField
Inherited from CvsText.tipTextSize
- Defined in index.ts:4259

tooltip

tooltip(tiptext: string, duration: number): CvsTextField
Create a tooltip for this control

Returns
this control
Parameters
- tiptext: string
  
  the text to appear in the tooltip
- duration: number
  
  how long the tip remains visible (milliseconds)
Returns CvsTextField
Inherited from CvsText.tooltip
- Defined in index.ts:4242

transparent

transparent(): CvsBaseControl
Makes the controls background fully transparent.

Returns
this control

Returns CvsBaseControl
Inherited from CvsText.transparent
- Defined in index.ts:4000

validate

validate(): CvsTextField
Force the control to validate

Returns
this control

Returns CvsTextField
- Defined in index.ts:6583

validation

validation(vfunc: Function): CvsTextField
Uesr provide a validation function for this textfield

Returns
this control
Parameters
- vfunc: Function
  
  the validation function
Returns CvsTextField
- Defined in index.ts:6574

Class CvsTextField

Since

Hierarchy

Index

Properties

Methods

Properties

Protected _clock

Protected _currCsrIdx

Protected _cursorOn

Protected _linkIndex

Protected _linkOffset

Protected _prevCsrIdx

Protected _textInvalid

Protected _validation

action

Methods

_activateNext

Parameters

offset: number

Returns void

addChild

Returns

Parameters

c: string | CvsBaseControl

Optional rx: number

Optional ry: number

Returns any

clearValid

Returns

Returns CvsTextField

corners

Returns

Parameters

c: number[]

Returns number[] | CvsBaseControl

disable

Returns

Parameters

Optional cascade: boolean

Returns CvsBaseControl

enable

Returns

Parameters

Optional cascade: boolean

Returns CvsBaseControl

getAbsXY

Returns

Returns __Position

getParent

Returns

Returns CvsPane | CvsBaseControl

hasValidText

Returns

Returns boolean

hide

Returns

Parameters

Optional cascade: boolean

Returns CvsBaseControl

index

Returns

Parameters

idx: number

Optional deltaIndex: number

Returns CvsTextField

invalidateBuffer

Returns

Returns CvsTextField

isEnabled

Returns

Returns boolean

isValid

Returns

Returns boolean

isVisible

Returns

Since

Returns boolean

leaveParent

`Protected` _clock

`Protected` _currCsrIdx

`Protected` _cursorOn

`Protected` _linkIndex

`Protected` _linkOffset

`Protected` _prevCsrIdx

`Protected` _textInvalid

`Protected` _validation

`Optional` rx: number

`Optional` ry: number

`Optional` cascade: boolean

`Optional` cascade: boolean

`Optional` cascade: boolean

`Optional` deltaIndex: number

`Optional` rx: number

`Optional` ry: number

`Optional` id: string

`Optional` cascade: boolean

`Optional` cascade: boolean

`Optional` dim: string

`Optional` t: string

`Optional` tsize: number