Class google.gdata.atom.Text

Object
   |
   +--google.gdata.atom.Text

Direct Known Subclasses:

google.gdata.maps.KmlContent

class google.gdata.atom.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 optional.

src

{string|undefined} src

External URI. This attribute is optional.

type

{string|undefined} type

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

google.gdata.atom.Text

google.gdata.atom.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, type, and uri.

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 optional.

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 optional.

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

getUri

string|undefined getUri()

Returns the external URI. This attribute is optional.

Returns:
External URI 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 optional.

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 optional.

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

setUri

void setUri(<string|undefined> uri)

Sets the external URI. This attribute is optional.

Parameters:
uri - External URI or undefined for none.

create

<static> google.gdata.atom.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.