# Titanium.UI.AttributedString

An attributed string proxy manages character strings and associated sets of attributes (for example, font and foregroundcolor) that apply to individual characters or ranges of characters in the string.

Availability

3.6.0

9.2.0

Extends

Titanium.Proxy

# Overview

The AttributedString proxy is created with the Titanium.UI.createAttributedString method.

The text property must be set initially in the constructor when creating an attributed string. The Titanium.UI.AttributedString.attributes can either be set in the constructor or after it has been created.

For examples of Attributed Strings, see the Attributed Strings guide (opens new window).

# Examples

# Adds an array of attributes to a label

Creates an AttributedString proxy, adds some attributes to it, and applies them to a Titanium.UI.Label.

var win = Titanium.UI.createWindow({
    backgroundColor: '#ddd',
});

win.open();

var text =  'Bacon ipsum dolor Titanium SDK rocks! sit amet fatback leberkas salami sausage tongue strip steak.';

var attr = Titanium.UI.createAttributedString({
    text: text,
    attributes: [
        // Underlines text
        {
            type: Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE,
            value: Ti.UI.ATTRIBUTE_UNDERLINE_STYLE_SINGLE,
            range: [text.indexOf('Titanium'), ('Titanium').length]
        },
        // Sets a background color
        {
            type: Titanium.UI.ATTRIBUTE_BACKGROUND_COLOR,
            value: "red",
            range: [text.indexOf('Appcelerator'), ('Appcelerator').length]
        },
        {
            type: Titanium.UI.ATTRIBUTE_BACKGROUND_COLOR,
            value: "blue",
            range: [text.indexOf('Titanium'), ('Titanium').length]
        },
        {
            type: Titanium.UI.ATTRIBUTE_BACKGROUND_COLOR,
            value: "yellow",
            range: [text.indexOf('rocks!'), ('rocks!').length]
        },
        // Sets a foreground color
        {
            type: Titanium.UI.ATTRIBUTE_FOREGROUND_COLOR,
            value: "orange",
            range: [0,  text.length]
        },
        {
            type: Titanium.UI.ATTRIBUTE_FOREGROUND_COLOR,
            value: "black",
            range: [text.indexOf('rocks!'), ('rocks!').length]
        }
    ]
});

var label = Titanium.UI.createLabel({
    left: 20,
    right: 20,
    height: Titanium.UI.SIZE,
    attributedString: attr
});

win.add(label);

# Adds attributes, one by one.

var win = Titanium.UI.createWindow({
    backgroundColor: '#ddd',
});

win.open();

var text =  'Bacon ipsum dolor Titanium SDK rocks! sit amet fatback leberkas salami sausage tongue strip steak.';

var attr = Titanium.UI.createAttributedString({
    text: text
});

// Underlines text
attr.addAttribute({
    type: Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE,
    range: [0, text.length]
});

var label = Titanium.UI.createLabel({
    left: 20,
    right: 20,
    height: Titanium.UI.SIZE,
    attributedString: attr
});

win.add(label);

# Links with underline color.

const win = Ti.UI.createWindow({
	backgroundColor: 'gray',
	layout: 'vertical'
});
const lbl_a = createLink();
const lbl_b = createLink();

colorLink(lbl_b);

win.add([lbl_a, lbl_b]);
win.open();

function createLink() {
	const label = Ti.UI.createLabel({
		top: 20,
		attributedString: Ti.UI.createAttributedString({
			text: 'Check out Titanium SDK',
			attributes: [{
				type: Ti.UI.ATTRIBUTE_LINK,
				value: 'https://titaniumsdk.com',
				range: [10, 12]
			}]
		})
	});

	label.addEventListener('link', e => {
		Ti.Platform.openURL(e.url);
	});

	return label;
}

function colorLink(lbl) {
	const attributedString = lbl.attributedString;
	const textColor = 'purple';
	const underlineColor = 'yellow';

	for (const attribute of attributedString.attributes) {
		if (attribute.type === Ti.UI.ATTRIBUTE_LINK) {

			// Set new link color.
			attributedString.addAttribute({
				type: Ti.UI.ATTRIBUTE_FOREGROUND_COLOR,
				value: textColor,
				range: attribute.range
			});

			// Set new underline color.
			attributedString.addAttribute({
				type: Ti.UI.ATTRIBUTE_UNDERLINE_COLOR,
				value: underlineColor,
				range: attribute.range
			});
		}
	}
}

# Properties

# apiName READONLY

Availability

3.6.0

9.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# attributes

Availability

3.6.0

9.2.0

attributes :Array<Attribute>

An array of attributes to add.

Internally, this calls the addAttribute method for each of the attributes passed in.

# bubbleParent

Availability

3.6.0

9.2.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# lifecycleContainer

Availability

3.6.0

lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# text

Availability

3.6.0

9.2.0

text :String

The text applied to the attributed string.

The text property must be set in the constructor and cannot be changed.

# Methods

# addAttribute

Availability

3.6.0

9.2.0

addAttribute(attribute) → void

Adds an Attribute with the given name and value to the characters in the specified range.

Parameters

Name	Type	Description
`attribute`	Attribute	An attribute object.

Returns

Type: void

# addEventListener

Availability

3.6.0

9.2.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

3.6.0

9.2.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# fireEvent

Availability

3.6.0

9.2.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`event`	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type: void

# removeEventListener

Availability

3.6.0

9.2.0

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void