Documentation

Toggle Menu

Text Box

This tile is good for collecting multiline text input or as a multiline text output to the user and/or displaying and editting multi-line strings.

Settings

Tag

This is a unique String ID assigned to this tile and is used (by you) to identify what tile sent what data by your script.
Note that this is case sensitive, and cannot contain any white space.

Size

This modifies the size of the button as it appears on your screen. Its units of measurement is tiles. Since each tile that can have its size modified is aware of its surroundings, the numeric steppers used to adjust the tile size will stop you from overlapping with other tiles or going over the edge of the screen.

Keyboard

Here you can set the keyboard type and the return key type for the tile.

Return Key Types

  • Done

  • Emergency Call

  • Go

  • Google

  • Join

  • Next

  • Return

  • Route

  • Search

  • Send

  • Yahoo

Keyboard Types

  • ASCII Capable

  • Decimal Pad

  • Default

  • Email Address

  • Name Phone Pad

  • Number Pad

  • Numbers and Punctuation

  • Phone Pad

  • Twitter

  • URL

  • Web Search

Text

Here you can set the appearance of the text on the tile. You can set the font, the font size, and the text alignment.

Text Alignment

  • Centre

  • Justified

  • Left

  • Natural

  • Right

Note that the font you choose may affect the performance of the app as it may take longer to render.

Action

Here you can set the action for the tile to take when the text value of the tile has changed or when the keyboard is dismissed. With this you can either:

  • Clear Text

  • Send Action → "\\\\VALUE CHANGED//" | "\\\\KEYBOARD DISMISSED//"

  • Send Text

Note that you can pick more than one action. If clear and send are both picked. The data will be sent, then cleared.

Settings

Here there are four settings. They will affect how the tile reacts to your touch and input from the server.

  • Scollable → YES | NO

  • Default Input Action → Append | Replace

  • Editable → YES | NO

  • Selectable → YES | NO

Note that the Default Action can be overridden by appending either "\\Append\\" or "\\Replace\\" before the data you want to set the tile to.

Input

You can modify the value of the tile by simply sending a string to the tile.

  • String → Just String Data → Do default action with String.

  • String → \\Append\\Just String Data → Add String data to the end of the current tile value.

  • String → \\Append_New\\Just String Data → Add String data to a new line at the end of the current tile value.

  • String → \\Replace\\Just String Data → Replace the tile value with the String data.

Usage Demo

Set the message thread text box to Welcome to the Force Chat. 

                            self.force.sendMessage("Jordan's iPhone", "messageThread", "\\Replace\\Welcome to the Force Chat")

Output

The following is what data is sent from this tile to the server/your script. It is in the format:
Action → Data Type → Value

  • Textbox Value Changed (Send Text)→ String → Tile's String Value

  • Textbox Value Changed (Send Action) → String → "\\\\VALUE CHANGED//"

  • Textbox Keyboard Dismissed (Send Text)→ String → Tile's String Value

  • Textbox Keyboard Dismissed (Send Action) → String → "\\\\KEYBOARD DISMISSED//"

Note that a tile's tag is always sent to the server for identification purposes.

Usage Demo

Pass the data received to a function to handle it. 

                            def forceServerDidReceiveData(self, deviceName, senderTag, data):
                                if senderTag == "messageThread":
                                    self.handleTextBoxInput(data)