scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-07 13:22:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add TextItem documentation.

Browse source
This commit is contained in:
Jonathan Puckey 2011-05-23 18:52:54 +02:00
parent 5bd935be75
commit 24689300c3
1 changed files with 35 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
src/text/TextItem.js
View file

@ -15,8 +15,21 @@
*/
var TextItem = this.TextItem = Item.extend({
/** @lends TextItem# */
beans: true,
/**
* @constructs TextItem
*
* @class The TextItem type allows you to create typography. Its
* functionality is inherited by different text item types such as
* {@link PointText}, and {@link AreaText} (coming soon). They each add a
* layer of functionality that is unique to their type, but share the
* underlying properties and functions that they inherit from TextItem.
*
* @extends Item
*/
initialize: function() {
this.base();
this.content = null;
@ -26,12 +39,27 @@ var TextItem = this.TextItem = Item.extend({
this.setParagraphStyle();
},
/**
* The text contents of the text item.
*
* @name TextItem#content
* @type string
*/
_clone: function(copy) {
copy.setCharacterStyle(this._characterStyle);
copy.setParagraphStyle(this._paragraphStyle);
return this.base(copy);
},
/**
* {@grouptitle Style Properties}
*
* The character style of the text item.
*
* @type CharacterStyle
* @bean
*/
getCharacterStyle: function() {
return this._characterStyle;
},
@ -39,7 +67,13 @@ var TextItem = this.TextItem = Item.extend({
setCharacterStyle: function(style) {
this._characterStyle.initialize(style);
},
/**
* The paragraph style of the text item.
*
* @type ParagraphStyle
* @bean
*/
getParagraphStyle: function() {
return this._paragraphStyle;
},