Skip to content

Commit

Permalink
enhanced documentation of 'TextField.formatText'
Browse files Browse the repository at this point in the history
  • Loading branch information
PrimaryFeather committed Jan 28, 2014
1 parent 8e7f2ad commit f379ea7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions starling/src/starling/text/TextField.as
Original file line number Diff line number Diff line change
Expand Up @@ -213,10 +213,14 @@ package starling.text
}
}

/** formatText is called immediately before the text is rendered. The intent of formatText
* is to be overridden in a subclass, so that you can provide custom formatting for TextField.
* <code>textField</code> is the flash.text.TextField object that you can specially format;
* <code>textFormat</code> is the default TextFormat for <code>textField</code>.
/** This method is called immediately before the text is rendered. The intent of
* 'formatText' is to be overridden in a subclass, so that you can provide custom
* formatting for the TextField. In the overriden method, call 'setFormat' (either
* over a range of characters or the complete TextField) to modify the format to
* your needs.
*
* @param textField: the flash.text.TextField object that you can format.
* @param textFormat: the default text format that's currently set on the text field.
*/
protected function formatText(textField:flash.text.TextField, textFormat:TextFormat):void {}

Expand Down

0 comments on commit f379ea7

Please sign in to comment.