TextField
Anthony Ma edited this page May 26, 2015
·
6 revisions
Clone this wiki locally
A component that allows for text input. #Fields
-
xdefault: 1 - x value of the component -
ydefault: 1 - y value of the component -
hdefault: 1 - height of the component -
wdefault: 16 - width of the component -
zdefault: 0 - z value of the component -
parent- parent window object of the component -
removed- whether the component has been queued for removal - should only be modified by the library itself -
visibledefault: true - whether the component is visible -
bgColordefault: colors.white - the background color -
textColordefault: colors.black - the color of the text -
placeholderColordefault: colors.lightGray - the color of the placeholder text -
placeholderdefault: "txUI TextField" - text displayed in when the field is empty -
textdefault: "" - text displayed by the label -
textAligndefault: "center" - alignment of the label text -
textMaskdefault: "" - text mask for password input -
activedefault: false - whether this is the active component - should only be modified by the library -
cursorPosdefault: 0 - position of the cursor in the textfield -
displayOffsetdefault: 0 - offset of the text in the textfield - should only be modified by the library
#Functions
-
function draw(self)- draws the field - should only be called by the library itself -
function click(self, x, y)- called by the library on a click event to check if the field has been clicked -
function action(self)- called by the library on a click event byfunction click(self, x, y) -
function key(self, keyCode)- called by the library on a key event -
function char(self, char)- called by the library on a char event -
function update(self)- called every update cycle and should not be modified -
function termX(self)- returns the x position on the terminal -
function termY(self)- returns the y position on the terminal -
function setPos(self, x, y)- sets the position of the component -
function setSize(self, w, h)- sets the size of the component