Titanium.UI.iOS.Attribute
> Titanium.UI.iOS.Attribute

An abstract datatype for specifying an attributed string attribute.

This class has been removed since 6.0.0

Use instead.

Attributes are added to the Titanium.UI.iOS.AttributedString object to create styled text. The attribute is a JavaScript Object containing three properties: type, value and range.

For examples of using Attributed Strings, see the Attributed Strings guide.

  • 3.2
  • 3.2
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

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, Button returns Ti.UI.Button.

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

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

  • 3.0.0
  • 3.0.0
  • 3.0.0

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

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.

  • 3.6.0
Titanium.UI.iOS.Attribute
range : Number[]

Attribute range.

Attribute range.

This specifies the range of text to apply the property to, as an array of two numbers: [from, length].

Titanium.UI.iOS.Attribute
value : Number

Attribute value.

Attribute value.

The value parameter depends on the type parameter. For example, to use the foreground color on the text you would use Titanium.UI.iOS.ATTRIBUTE_FOREGROUND_COLOR for the type and a color value for the value:

{
    type: Titanium.UI.iOS.ATTRIBUTE_FOREGROUND_COLOR,
    value: '#DDD',
    range: [0, 100]
}

If you use Titanium.UI.iOS.ATTRIBUTE_UNDERLINES_STYLE or Titanium.UI.iOS.ATTRIBUTE_STRIKETHROUGH_COLOR, you must use one or more of these constants:

These can be combined:

{
    type: Titanium.UI.iOS.ATTRIBUTE_UNDERLINES_STYLE,
    value: Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_SINGLE | Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_DASH,
    range: [0, 100]
}

If you use the Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION, you must use one or more of these constants:

These can also be combined the same way as the underline styles.

If you use the Titanium.UI.iOS.ATTRIBUTE_SHADOW, the value must be a JavaScript object containing any of the offset, blurRadius or color properties:

{
    offset: {
        width: 10,
        height: 10
    },
    blurRadius: 10,
    color: 'red'
}

If you use the Titanium.UI.iOS.ATTRIBUTE_TEXT_EFFECT, you must use the only supported iOS 7 constant Titanium.UI.iOS.ATTRIBUTE_LETTERPRESS_STYLE.

This API can be assigned the following constants:

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.UI.iOS.Attribute
( ) : Number[]
Gets the value of the range property. ...

Gets the value of the range property.

Returns

  • Number[]
Titanium.UI.iOS.Attribute
( ) : Number
Gets the value of the type property. ...

Gets the value of the type property.

Returns

  • Number
Titanium.UI.iOS.Attribute
( ) : Number
Gets the value of the value property. ...

Gets the value of the value property.

Returns

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

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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.UI.iOS.Attribute
( range )
Sets the value of the range property. ...

Sets the value of the range property.

Parameters

  • range : Array<Number>

    New value for the property.

Returns

  • void
Titanium.UI.iOS.Attribute
( type )
Sets the value of the type property. ...

Sets the value of the type property.

Parameters

  • type : Number

    New value for the property.

Returns

  • void
Titanium.UI.iOS.Attribute
( value )
Sets the value of the value property. ...

Sets the value of the value property.

Parameters

  • value : Number

    New value for the property.

Returns

  • void