bbbfly. EditBox class control

new bbbfly.EditBox (def, ref, parent)

Basic EditBox Control. Implements Hintified interface if hint package is inluded.

Parameters

Name Type Description
def bbbfly.EditBox.Definition optional Descendant definition
ref object optional Reference owner
parent object | string optional Parent DIV element or it's ID

Properties

Name Type Default Description
WrapperOptions object
Orientation bbbfly.Wrapper.orientation horizontal
TrackChanges boolean true
ButtonDef bbbfly.Button.Definition Definition shared by all buttons
Text string null Text string
TextAlign bbbfly.EditBox.textalign left Text horizontal align
AltText string null Alternative text string
AltTextRes string null Alternative text resource ID
InputType bbbfly.EditBox.inputtype text
AutoComplete string | null null
MaxLength integer | null null Max number of characters
SelectText boolean false If select text on focus
SubmitButton string null Submit button ID
CancelButton string null Cancel button ID

Extends

Implements

In Packages

Interfaces

Members

static inputtype enum integer

Possible values for bbbfly.EditBox.InputType
Name Type Default Description
password integer 0
text integer 1
decimal integer 2
email integer 3
numeric integer 4
search integer 5
phone integer 6
url integer 7

static textalign enum integer

Possible values for bbbfly.EditBox.TextAlign
Name Type Default Description
left integer 1
center integer 2
right integer 3

Methods

inherited AddChildControl (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:
See:

inherited CreateControl (def){object|null}

Parameters:
Name Type Description
def ngControl.Definition optional Child control definition
See:
Returns:
Type Description
object | null Created control

inherited DisposeControls ()

See:
See:
See:

FocusStart ()

See:

inherited GetAlt (){string|null}

See:
Returns:
Type Description
string | null

GetAltText (){string|null}

See:
Returns:
Type Description
string | null

GetButton (buttonId){bbbfly.Button|null}

Parameters:
Name Type Description
buttonId string Required button's id
See:
Returns:
Type Description
bbbfly.Button | null Button with passes id

GetButtons (){object}

See:
Returns:
Type Description
object

GetCaretPos (){integer}

See:
Returns:
Type Description
integer Caret position

inherited GetClassName (suffix){string}

Parameters:
Name Type Description
suffix string optional Control part class name
Returns:
Type Description
string Control class name

inherited GetControlsHolder (){object}

See:
Returns:
Type Description
object ControlsPanel control or self

inherited GetControlsPanel (){object|null}

See:
Returns:
Type Description
object | null ControlsPanel control

inherited GetFrame (){bbbfly.Renderer.frame}

Returns:
Type Description
bbbfly.Renderer.frame Frame definition

inherited GetFrameDims (){object}

Returns:
Type Description
object Frame dimensions

inherited GetFramePanel (){object|null}

See:
Returns:
Type Description
object | null FramePanel control

GetInputPanel (){object|null}

See:
Returns:
Type Description
object | null Input panel control

inherited GetState (){bbbfly.Renderer.state}

Returns:
Type Description
bbbfly.Renderer.state Control state

GetText (){string|null}

See:
Returns:
Type Description
string | null

inherited RemoveChildControl (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited SetAlt (alt, update)

Parameters:
Name Type Default Description
alt string | null Value to set
update boolean true optional If update control
See:

SetAltText (text, update, forceChange)

Parameters:
Name Type Default Description
text string | null Value to set
update boolean true optional If update control
forceChange boolean false optional Force to act like value has changed
See:

SetCaretPos (pos)

Parameters:
Name Type Description
pos integer Caret position
See:

inherited SetEnabled (enabled, update){boolean}

Parameters:
Name Type Default Description
enabled boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

inherited SetInvalid (invalid, update){boolean}

Parameters:
Name Type Default Description
invalid boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

inherited SetOverflow (overflowX, overflowY, update){boolean}

Parameters:
Name Type Default Description
overflowX bbbfly.Renderer.overflow hidden optional Horizontal value to set
overflowY bbbfly.Renderer.overflow hidden optional Vertical value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

inherited SetReadOnly (readonly, update){boolean}

Parameters:
Name Type Default Description
readonly boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

inherited SetSelected (selected, update){boolean}

Parameters:
Name Type Default Description
selected boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

SetText (text, update, forceChange){boolean}

Parameters:
Name Type Default Description
text string | null Value to set
update boolean true optional If update control
forceChange boolean false optional Force to act like value has changed
See:
Returns:
Type Description
boolean False if change was denied

inherited TrackChildControls ()

inherited TrackControl (ctrl, track)

Parameters:
Name Type Default Description
ctrl ngControl optional Tracked control reference
track boolean true optional Pass false to cancel tracking

Events

inherited IsTrackedControlChanged (ctrl, options)

Parameters:
Name Type Description
ctrl ngControl optional Tracked control reference
options object optional Per tracker options
See:

OnAltTextChanged ()

See:

OnBlur (input){boolean}

Parameters:
Name Type Description
input HTMLInputElement Input element
See:
Returns:
Type Description
boolean Return false to deny any changes

inherited OnChildControlAdded (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited OnChildControlRemoved (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited OnEnabledChanged ()

See:

OnFocus (input){boolean}

Parameters:
Name Type Description
input HTMLInputElement Input element
See:
Returns:
Type Description
boolean Return false to deny any hanges

inherited OnInvalidChanged ()

See:

OnKeyDown (code, input){boolean}

Parameters:
Name Type Description
code integer Pressed key code
input HTMLInputElement Input element
See:
Returns:
Type Description
boolean Return false to deny any hanges

OnKeyUp (code, input){boolean}

Parameters:
Name Type Description
code integer Pressed key code
input HTMLInputElement Input element
See:
Returns:
Type Description
boolean Return false to deny any changes

inherited OnOverflowChanged ()

See:

inherited OnReadOnlyChanged ()

See:

inherited OnSelectedChanged ()

See:

inherited OnSetAlt (alt, update){boolean}

Parameters:
Name Type Default Description
alt boolean Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean Return false to deny value change

OnSetAltText (text, update){boolean}

Parameters:
Name Type Default Description
text boolean Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetEnabled (enabled){boolean}

Parameters:
Name Type Description
enabled boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetInvalid (invalid){boolean}

Parameters:
Name Type Description
invalid boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetOverflow (overflowX, overflowY){boolean}

Parameters:
Name Type Description
overflowX bbbfly.Renderer.overflow optional Horizontal value to set
overflowY bbbfly.Renderer.overflow optional Vertical value to set
See:
Returns:
Type Description
boolean Return false to deny values change

inherited OnSetReadOnly (readonly){boolean}

Parameters:
Name Type Description
readonly boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetSelected (selected){boolean}

Parameters:
Name Type Description
selected boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

OnSetText (text, update){boolean}

Parameters:
Name Type Default Description
text boolean Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean Return false to deny value change

OnTextChanged ()

See:

inherited OnTrackedControlChanged (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Tracked control reference