Class GTextField<TProps, TType>

A text display object.

Type Parameters

TProps extends IGTextField = IGTextField
TType extends PropertyType = PropertyType

Hierarchy (View Summary)

GObject<TProps, TType>
- GTextField
  - GRichTextField
  - GTextInput

Index

Properties

Methods

addEventListener addGear addRelation clone copy detach dispatchEvent dispose equals getAlign getAlpha getAspect getAutoClearText getAutoSize getBlendMode getBold getColor getCustomData getDemoText getExtension getExtras getFaceDilate getFilter getFilterData getFont getFontSize getGrayed getGroup getHeight getId getInitHeight getInitWidth getItalic getLeading getLetterSpacing getLocked getMaxHeight getMaxWidth getMinHeight getMinWidth getName getPivotAsAnchor getPivotX getPivotY getRelations getRotation getScaleX getScaleY getShadowColor getShadowOffset getShadowOffsetX getShadowOffsetY getSingleLine getSkewX getSkewY getSourceHeight getSourceWidth getStrikethrough getStrokeColor getStrokeSize getTemplateVarsEnabled getText getTooltips getTouchable getUbbEnabled getUnderlaySoftness getUnderline getVAlign getVisible getWidth getX getY isDisposed listExtensions listGears listParents removeEventListener removeGear setAlign setAlpha setAspect setAutoClearText setAutoSize setBlendMode setBold setColor setCustomData setDemoText setExtension setExtras setFaceDilate setFilter setFilterData setFont setFontSize setGrayed setGroup setId setInitHeight setInitWidth setItalic setLeading setLetterSpacing setLocked setMaxHeight setMaxWidth setMinHeight setMinWidth setName setPivot setPivotAsAnchor setRelations setRotation setScale setShadowColor setShadowOffset setShadowOffsetX setShadowOffsetY setSingleLine setSize setSkew setSourceHeight setSourceWidth setStrikethrough setStrokeColor setStrokeSize setTemplateVarsEnabled setText setTooltips setTouchable setUbbEnabled setUnderlaySoftness setUnderline setVAlign setVisible setX setXY setY

Properties

propertyType

propertyType: TType

Methods

addEventListener

addEventListener(type: string, listener: EventListener<GraphNodeEvent>): this
Parameters
- type: string
- listener: EventListener<GraphNodeEvent>
Returns this
Inherited from GObject.addEventListener
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:98

addGear

addGear(gear: Gear): this
**** Gears *****
Parameters
- gear: Gear
Returns this
Inherited from GObject.addGear
- Defined in packages/core/src/properties/g-object.ts:166

addRelation

addRelation(relation: RelationDef): this
Parameters
- relation: RelationDef
Returns this
Inherited from GObject.addRelation
- Defined in packages/core/src/properties/g-object.ts:159

clone

clone(): this
Returns this
Inherited from GObject.clone
- Defined in packages/core/src/properties/property.ts:130

copy

copy(other: this, resolve?: PropertyResolver<Property<IProperty>>): this
Parameters
- other: this
- resolve: PropertyResolver<Property<IProperty>> = COPY_IDENTITY
Returns this
Inherited from GObject.copy
- Defined in packages/core/src/properties/property.ts:135

detach

detach(): this
Removes all inbound references to this object. At the end of the process the object is considered 'detached': it may hold references to child resources, but nothing holds references to it. A detached object may be re-attached.

Returns this
Inherited from GObject.detach
- Defined in packages/core/src/properties/property.ts:216

dispatchEvent

dispatchEvent(event: BaseEvent): this
Dispatches an event on the GraphNode, and on the associated Graph. Event types on the graph are prefixed, "node:[type]".
Parameters
- event: BaseEvent
Returns this
Inherited from GObject.dispatchEvent
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:227

dispose

dispose(): void
Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

Returns void
Inherited from GObject.dispose
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:168

equals

equals(other: this, skip?: Set<string>): boolean
Parameters
- other: this
- skip: Set<string> = EMPTY_SET
Returns boolean
Inherited from GObject.equals
- Defined in packages/core/src/properties/property.ts:188

getAlign

getAlign(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:202

getAlpha

getAlpha(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:172

getAspect

getAspect(): boolean
Returns boolean
Inherited from GObject.getAspect
- Defined in packages/core/src/properties/g-object.ts:108

getAutoClearText

getAutoClearText(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:220

getAutoSize

getAutoSize(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:214

getBlendMode

getBlendMode(): string
Returns string
Inherited from GObject.getBlendMode
- Defined in packages/core/src/properties/g-object.ts:145

getBold

getBold(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:244

getColor

getColor(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:199

getCustomData

getCustomData(): string
Returns string
Overrides GObject.getCustomData
- Defined in packages/core/src/properties/g-text-field.ts:190

getDemoText

getDemoText(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:223

getExtension

getExtension<Prop extends ExtensionProperty<IExtensibleProperty>>(
name: string,
): Prop
Type Parameters
- Prop extends ExtensionProperty<IExtensibleProperty>
Parameters
- name: string
Returns Prop
Inherited from GObject.getExtension
- Defined in packages/core/src/properties/extensible-property.ts:19

getExtras

getExtras(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from GObject.getExtras
- Defined in packages/core/src/properties/property.ts:122

getFaceDilate

getFaceDilate(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:229

getFilter

getFilter(): string
Returns string
Inherited from GObject.getFilter
- Defined in packages/core/src/properties/g-object.ts:147

getFilterData

getFilterData(): string
Returns string
Inherited from GObject.getFilterData
- Defined in packages/core/src/properties/g-object.ts:149

getFont

getFont(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:193

getFontSize

getFontSize(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:196

getGrayed

getGrayed(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:184

getGroup

getGroup(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:169

getHeight

getHeight(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:139

getId

getId(): string
Returns string
Inherited from GObject.getId
- Defined in packages/core/src/properties/g-object.ts:93

getInitHeight

getInitHeight(): number
Returns number
Inherited from GObject.getInitHeight
- Defined in packages/core/src/properties/g-object.ts:103

getInitWidth

getInitWidth(): number
Returns number
Inherited from GObject.getInitWidth
- Defined in packages/core/src/properties/g-object.ts:101

getItalic

getItalic(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:241

getLeading

getLeading(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:208

getLetterSpacing

getLetterSpacing(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:211

getLocked

getLocked(): boolean
Returns boolean
Inherited from GObject.getLocked
- Defined in packages/core/src/properties/g-object.ts:106

getMaxHeight

getMaxHeight(): number
Returns number
Overrides GObject.getMaxHeight
- Defined in packages/core/src/properties/g-text-field.ts:143

getMaxWidth

getMaxWidth(): number
Returns number
Overrides GObject.getMaxWidth
- Defined in packages/core/src/properties/g-text-field.ts:141

getMinHeight

getMinHeight(): number
Returns number
Overrides GObject.getMinHeight
- Defined in packages/core/src/properties/g-text-field.ts:142

getMinWidth

getMinWidth(): number
Returns number
Overrides GObject.getMinWidth
- Defined in packages/core/src/properties/g-text-field.ts:140

getName

getName(): string
Returns string
Inherited from GObject.getName
- Defined in packages/core/src/properties/property.ts:114

getPivotAsAnchor

getPivotAsAnchor(): boolean
Returns boolean
Overrides GObject.getPivotAsAnchor
- Defined in packages/core/src/properties/g-text-field.ts:161

getPivotX

getPivotX(): number
Returns number
Overrides GObject.getPivotX
- Defined in packages/core/src/properties/g-text-field.ts:159

getPivotY

getPivotY(): number
Returns number
Overrides GObject.getPivotY
- Defined in packages/core/src/properties/g-text-field.ts:160

getRelations

getRelations(): RelationDef[]
**** Relations *****

Returns RelationDef[]
Inherited from GObject.getRelations
- Defined in packages/core/src/properties/g-object.ts:157

getRotation

getRotation(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:175

getScaleX

getScaleX(): number
Returns number
Inherited from GObject.getScaleX
- Defined in packages/core/src/properties/g-object.ts:129

getScaleY

getScaleY(): number
Returns number
Inherited from GObject.getScaleY
- Defined in packages/core/src/properties/g-object.ts:130

getShadowColor

getShadowColor(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:256

getShadowOffset

getShadowOffset(): ShadowOffsetLike
Returns ShadowOffsetLike
- Defined in packages/core/src/properties/g-text-field.ts:265

getShadowOffsetX

getShadowOffsetX(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:259

getShadowOffsetY

getShadowOffsetY(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:262

getSingleLine

getSingleLine(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:217

getSkewX

getSkewX(): number
Returns number
Inherited from GObject.getSkewX
- Defined in packages/core/src/properties/g-object.ts:136

getSkewY

getSkewY(): number
Returns number
Inherited from GObject.getSkewY
- Defined in packages/core/src/properties/g-object.ts:137

getSourceHeight

getSourceHeight(): number
Returns number
Inherited from GObject.getSourceHeight
- Defined in packages/core/src/properties/g-object.ts:98

getSourceWidth

getSourceWidth(): number
Returns number
Inherited from GObject.getSourceWidth
- Defined in packages/core/src/properties/g-object.ts:96

getStrikethrough

getStrikethrough(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:247

getStrokeColor

getStrokeColor(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:250

getStrokeSize

getStrokeSize(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:253

getTemplateVarsEnabled

getTemplateVarsEnabled(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:226

getText

getText(): string
Returns string
- Defined in packages/core/src/properties/g-text-field.ts:133

getTooltips

getTooltips(): string
Returns string
Overrides GObject.getTooltips
- Defined in packages/core/src/properties/g-text-field.ts:187

getTouchable

getTouchable(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:181

getUbbEnabled

getUbbEnabled(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:235

getUnderlaySoftness

getUnderlaySoftness(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:232

getUnderline

getUnderline(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:238

getVAlign

getVAlign(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:205

getVisible

getVisible(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-text-field.ts:178

getWidth

getWidth(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:138

getX

getX(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:136

getY

getY(): number
Returns number
- Defined in packages/core/src/properties/g-text-field.ts:137

isDisposed

isDisposed(): boolean
Returns true if the node has been permanently removed from the graph.

Returns boolean
Inherited from GObject.isDisposed
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:162

listExtensions

listExtensions(): ExtensionProperty<IExtensibleProperty>[]
Returns ExtensionProperty<IExtensibleProperty>[]
Inherited from GObject.listExtensions
- Defined in packages/core/src/properties/extensible-property.ts:27

listGears

listGears(): Gear[]
Returns Gear[]
Inherited from GObject.listGears
- Defined in packages/core/src/properties/g-object.ts:168

listParents

listParents(): Property<IProperty>[]
Returns Property<IProperty>[]
Inherited from GObject.listParents
- Defined in packages/core/src/properties/property.ts:221

removeEventListener

removeEventListener(type: string, listener: EventListener<GraphNodeEvent>): this
Parameters
- type: string
- listener: EventListener<GraphNodeEvent>
Returns this
Inherited from GObject.removeEventListener
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:99

removeGear

removeGear(gear: Gear): this
Parameters
- gear: Gear
Returns this
Inherited from GObject.removeGear
- Defined in packages/core/src/properties/g-object.ts:167

setAlign

setAlign(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:203

setAlpha

setAlpha(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:173

setAspect

setAspect(v: boolean): this
Parameters
- v: boolean
Returns this
Inherited from GObject.setAspect
- Defined in packages/core/src/properties/g-object.ts:109

setAutoClearText

setAutoClearText(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:221

setAutoSize

setAutoSize(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:215

setBlendMode

setBlendMode(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setBlendMode
- Defined in packages/core/src/properties/g-object.ts:146

setBold

setBold(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:245

setColor

setColor(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:200

setCustomData

setCustomData(v: string): this
Parameters
- v: string
Returns this
Overrides GObject.setCustomData
- Defined in packages/core/src/properties/g-text-field.ts:191

setDemoText

setDemoText(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:224

setExtension

setExtension<Prop extends ExtensionProperty<IExtensibleProperty>>(
name: string,
extensionProperty: Prop,
): this
Type Parameters
- Prop extends ExtensionProperty<IExtensibleProperty>
Parameters
- name: string
- extensionProperty: Prop
Returns this
Inherited from GObject.setExtension
- Defined in packages/core/src/properties/extensible-property.ts:23

setExtras

setExtras(extras: Record<string, unknown>): this
Parameters
- extras: Record<string, unknown>
Returns this
Inherited from GObject.setExtras
- Defined in packages/core/src/properties/property.ts:126

setFaceDilate

setFaceDilate(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:230

setFilter

setFilter(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setFilter
- Defined in packages/core/src/properties/g-object.ts:148

setFilterData

setFilterData(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setFilterData
- Defined in packages/core/src/properties/g-object.ts:150

setFont

setFont(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:194

setFontSize

setFontSize(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:197

setGrayed

setGrayed(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:185

setGroup

setGroup(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:170

setId

setId(id: string): this
Parameters
- id: string
Returns this
Inherited from GObject.setId
- Defined in packages/core/src/properties/g-object.ts:94

setInitHeight

setInitHeight(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setInitHeight
- Defined in packages/core/src/properties/g-object.ts:104

setInitWidth

setInitWidth(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setInitWidth
- Defined in packages/core/src/properties/g-object.ts:102

setItalic

setItalic(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:242

setLeading

setLeading(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:209

setLetterSpacing

setLetterSpacing(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:212

setLocked

setLocked(v: boolean): this
Parameters
- v: boolean
Returns this
Inherited from GObject.setLocked
- Defined in packages/core/src/properties/g-object.ts:107

setMaxHeight

setMaxHeight(v: number): this
Parameters
- v: number
Returns this
Overrides GObject.setMaxHeight
- Defined in packages/core/src/properties/g-text-field.ts:155

setMaxWidth

setMaxWidth(v: number): this
Parameters
- v: number
Returns this
Overrides GObject.setMaxWidth
- Defined in packages/core/src/properties/g-text-field.ts:153

setMinHeight

setMinHeight(v: number): this
Parameters
- v: number
Returns this
Overrides GObject.setMinHeight
- Defined in packages/core/src/properties/g-text-field.ts:154

setMinWidth

setMinWidth(v: number): this
Parameters
- v: number
Returns this
Overrides GObject.setMinWidth
- Defined in packages/core/src/properties/g-text-field.ts:152

setName

setName(name: string): this
Parameters
- name: string
Returns this
Inherited from GObject.setName
- Defined in packages/core/src/properties/property.ts:118

setPivot

setPivot(x: number, y: number, anchor?: boolean): this
Parameters
- x: number
- y: number
- anchor: boolean = false
Returns this
Overrides GObject.setPivot
- Defined in packages/core/src/properties/g-text-field.ts:162

setPivotAsAnchor

setPivotAsAnchor(v: boolean): this
Parameters
- v: boolean
Returns this
Overrides GObject.setPivotAsAnchor
- Defined in packages/core/src/properties/g-text-field.ts:167

setRelations

setRelations(relations: RelationDef[]): this
Parameters
- relations: RelationDef[]
Returns this
Inherited from GObject.setRelations
- Defined in packages/core/src/properties/g-object.ts:158

setRotation

setRotation(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:176

setScale

setScale(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Inherited from GObject.setScale
- Defined in packages/core/src/properties/g-object.ts:131

setShadowColor

setShadowColor(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:257

setShadowOffset

setShadowOffset(v: ShadowOffsetLike): this
Parameters
- v: ShadowOffsetLike
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:271

setShadowOffsetX

setShadowOffsetX(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:260

setShadowOffsetY

setShadowOffsetY(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:263

setSingleLine

setSingleLine(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:218

setSize

setSize(w: number, h: number): this
Parameters
- w: number
- h: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:148

setSkew

setSkew(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Inherited from GObject.setSkew
- Defined in packages/core/src/properties/g-object.ts:138

setSourceHeight

setSourceHeight(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setSourceHeight
- Defined in packages/core/src/properties/g-object.ts:99

setSourceWidth

setSourceWidth(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setSourceWidth
- Defined in packages/core/src/properties/g-object.ts:97

setStrikethrough

setStrikethrough(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:248

setStrokeColor

setStrokeColor(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:251

setStrokeSize

setStrokeSize(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:254

setTemplateVarsEnabled

setTemplateVarsEnabled(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:227

setText

setText(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:134

setTooltips

setTooltips(v: string): this
Parameters
- v: string
Returns this
Overrides GObject.setTooltips
- Defined in packages/core/src/properties/g-text-field.ts:188

setTouchable

setTouchable(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:182

setUbbEnabled

setUbbEnabled(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:236

setUnderlaySoftness

setUnderlaySoftness(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:233

setUnderline

setUnderline(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:239

setVAlign

setVAlign(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:206

setVisible

setVisible(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:179

setX

setX(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:156

setXY

setXY(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:144

setY

setY(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-text-field.ts:157