Developer Resources

Label

Overview

The Label class represents a label control.

Base Class

FormControl

Constructor

Label(text : String, x_pos : Integer, y_pos : Integer, width : Integer, height : Integer)

Arguments

text
The text of the label.
x_pos
The x position of the label.
y_pos
The y position of the label.
width
The width of the label.
height
The height of the label.

Methods

Label.getLabel
Gets the text of the label.
Label.setLabel
Sets the text of the label.
Label.wrap
Sets the width to which to wrap the label's text

Inherited Methods

FormControl.captureMouse
Captures the mouse on this form control.
FormControl.disablePaint
Disables the window from redrawing itself.
FormControl.enablePaint
Enables the window to redraw itself.
FormControl.getBackgroundColor
Gets the background color of the form control.
FormControl.getClientSize
Gets the client size of the form control.
FormControl.getEnabled
Indicates whether or not a form control is enabled.
FormControl.getFont
Gets the default font for the text of form control.
FormControl.getForegroundColor
Gets the foreground color of the form control.
FormControl.getMaxSize
Gets the maximum size of the form control.
FormControl.getMinSize
Gets the minimum size of the form control.
FormControl.getMousePosition
Gets the mouse position relative to this form control.
FormControl.getNativeHandle
Gets the native handle of the window/control
FormControl.getPosition
Gets the position of a form control.
FormControl.getSize
Gets the size of the form control.
FormControl.invalidate
Invalidates a form control, which will cause it to be repainted on the next paint event.
FormControl.refresh
Refreshes a form control, which immediately repaints the entire form control.
FormControl.releaseMouse
Releases the mouse from being captured on this form control.
FormControl.setBackgroundColor
Sets the background color of the form control.
FormControl.setClientSize
Sets the client size of a form control.
FormControl.setEnabled
Enables or disables the form control.
FormControl.setFocus
Sets the focus to the form control.
FormControl.setFont
Sets the default font for the text of the form control.
FormControl.setForegroundColor
Sets the foreground color of the form control.
FormControl.setMaxSize
Sets the maximum size of a form control.
FormControl.setMinSize
Sets the minimum size of a form control.
FormControl.setPosition
Sets the position of a form control relative to the the form control's parent.
FormControl.setSize
Sets the size of a form control.
FormControl.show
Shows or hides the form control.
FormControl.update
Updates a form control, which will immediately repaint any invalid areas.

Label.getLabel

function Label.getLabel() : String

Returns

Returns the text of the label.

Description

Gets the text of the label.

Label.setLabel

function Label.setLabel(text : String)

Arguments

text
The text to which to set the label's text.

Description

Sets the text of the label.

Label.wrap

function Label.wrap(width : Integer)

Arguments

width
The width to which to wrap the label's text.

Description

Sets the width to which wrap the label's text.