Class google.gdata.Text

Object
   |
   +--google.gdata.Text

class google.gdata.Text

Describes a text construct containing either plain text, HTML, or XHTML.
Defined in gdata.js

Field Detail

$t

String|Undefined $t

Text content. This attribute is required.

type

String|Undefined type

Type of text construct (typically 'text', 'html' or 'xhtml'). This attribute is required.

google.gdata.Text

google.gdata.Text(<Object> opt_params)

Constructs a text construct using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: lang, text, and type

getLang

String|Undefined getLang()

Returns the language of link title. This attribute is optional.

Returns:
Language of link title or undefined for none

getText

String|Undefined getText()

Returns the text content. This attribute is required.

Returns:
Text content or undefined for none

getType

String|Undefined getType()

Returns the type of text construct (typically 'text', 'html' or 'xhtml'). This attribute is required.

Returns:
Type of text construct (typically 'text', 'html' or 'xhtml') or undefined for none

setLang

void setLang(<String|Undefined> lang)

Sets the language of link title. This attribute is optional.

Parameters:
lang - Language of link title or undefined for none

setText

void setText(<String|Undefined> text)

Sets the text content. This attribute is required.

Parameters:
text - Text content or undefined for none

setType

void setType(<String|Undefined> type)

Sets the type of text construct (typically 'text', 'html' or 'xhtml'). This attribute is required.

Parameters:
type - Type of text construct (typically 'text', 'html' or 'xhtml') or undefined for none

create

<static> google.gdata.Text create(<String> text, <String> opt_type)

Create a new text construct using the typical parameters.

Parameters:
text - Text content
opt_type - Optional type of text construct (default is 'text')

Returns:
new text content