Class Strings

(Mostly an abstract class)

Inheritance

Object Strings 🡄 Object

Properties

Count The number of strings in this list.
LineBreak The character(s) to count as a linebreak.
String [ String ] Array to access one specific string in the list.
Text All the strings in one string.

Methods

add () Adds a string to the list.
beginUpdate () Stops updates from triggering other events (prevents flashing).
clear () Deletes all strings in the list.
delete ( index ) Deletes a string from the list.
endUpdate () Call after beginUpdate.
getCount () Returns the number of strings in the list.
getString ( index ) Gets the string at the given index.
getText () Returns all the strings as one big string.
indexOf () Returns the index of the specified string.
insert ( index, string ) Inserts a string at a specific spot moving the items after it.
loadFromFile ( filename ) Load the strings from a textfile.
remove ( string ) Removes the given string from the list.
saveToFile ( filename ) Save the strings to a textfile.
setString ( index, string ) Replaces the string at the given index.
setText () Sets the strings of the given strings object to the given text (can be multiline).


Inheritance

Object
Strings 🡄 Object

Properties

Count
The number of strings in this list.

Type:

    Integer
LineBreak
The character(s) to count as a linebreak.

Type:

    String
String [ String ]
Array to access one specific string in the list.

[] = String[]

Type:

    array
Text
All the strings in one string.

Type:

    String

Methods

add ()
Adds a string to the list. param string
beginUpdate ()
Stops updates from triggering other events (prevents flashing).
clear ()
Deletes all strings in the list.
delete ( index )
Deletes a string from the list.

Parameters:

  • index int
endUpdate ()
Call after beginUpdate.
getCount ()
Returns the number of strings in the list.

Returns:

    int
getString ( index )
Gets the string at the given index.

Parameters:

  • index int

Returns:

    String
getText ()
Returns all the strings as one big string.
indexOf ()
Returns the index of the specified string. Returns -1 if not found.

param string

insert ( index, string )
Inserts a string at a specific spot moving the items after it.

Parameters:

  • index int
  • string
loadFromFile ( filename )
Load the strings from a textfile.

Parameters:

  • filename
remove ( string )
Removes the given string from the list.

Parameters:

  • string
saveToFile ( filename )
Save the strings to a textfile.

Parameters:

  • filename
setString ( index, string )
Replaces the string at the given index.

Parameters:

  • index int
  • string
setText ()
Sets the strings of the given strings object to the given text (can be multiline).
generated by LDoc 1.4.6-antum-dev-1 Last updated 2019-02-27 23:30:35