| { "type": "class", | |
| "qname": "org.apache.royale.textLayout.formats.TabStopFormat", | |
| "baseClassname": "" | |
| , | |
| "description": "The TabStopFormat class represents the properties of a tab stop in a paragraph. You can set the <code>TextLayoutFormat.tabstops</code> property to an array of TabStopFormat objects.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["org.apache.royale.textLayout.elements.TabElement", "org.apache.royale.textLayout.formats.TextLayoutFormat#tabStops"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "Object", | |
| "qname": "description", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Property descriptions accessible by name. @private"}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "org.apache.royale.textLayout.formats.ITabStopFormat", | |
| "qname": "emptyTabStopFormat", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Returns an ITabStopFormat instance with all properties set to <code>undefined</code>.", | |
| "tags": [ | |
| { "tagName": "private", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "getStyle", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Return the value of the style specified by the <code>styleProp</code> parameter which specifies the style name. accessed. Returns <code>undefined</code> if the style is not set.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["styleProp The name of the style whose value is to be retrieved."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["The value of the specified style. The type varies depending on the type of the style being"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "*", | |
| "params": [{ "name": "styleName", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "setStyle", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Set the value of the style specified by the <code>styleProp</code> parameter which specifies the style name to <code>value</code>.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["styleProp The name of the style whose value is to be set.", "value The value to set."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "styleName", "type": "String"}, | |
| { "name": "value", "type": "*"}]} | |
| , | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "*", | |
| "qname": "position", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The position of the tab stop, in pixels, relative to the start edge of the column. <p>Legal values are numbers from 0 to 10000 and FormatValue.INHERIT.</p> <p>Default value is undefined indicating not set.</p> <p>If undefined during the cascade this property will have a value of 0.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["FormatValue#INHERIT"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "throws", | |
| "values": ["RangeError when set value is not within range for this property"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "*", | |
| "qname": "alignment", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The tab alignment for this tab stop. <p>Legal values are TabAlignment.START, TabAlignment.CENTER, TabAlignment.END, TabAlignment.DECIMAL, FormatValue.INHERIT.</p> <p>Default value is undefined indicating not set.</p> <p>If undefined during the cascade this property will have a value of TabAlignment.START.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["FormatValue#INHERIT", "org.apache.royale.text.engine.TabAlignment"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "throws", | |
| "values": ["RangeError when set value is not within range for this property"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "*", | |
| "qname": "decimalAlignmentToken", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The alignment token to be used if the alignment is DECIMAL. <p>Default value is undefined indicating not set.</p> <p>If undefined during the cascade this property will have a value of null.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "throws", | |
| "values": ["RangeError when set value is not within range for this property"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "org.apache.royale.textLayout.formats.TabStopFormat", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Creates a new TabStopFormat object. All settings are empty or, optionally, are initialized from the supplied <code>initialValues</code> object.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#defaultFormat"]}, | |
| { "tagName": "param", | |
| "values": ["initialValues optional instance from which to copy initial values."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": [{ "name": "initialValues", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "copy", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Copies TabStopFormat settings from the <code>values</code> ITabStopFormat instance into this TabStopFormat object. If <code>values</code> is <code>null</code>, this TabStopFormat object is initialized with undefined values for all properties.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["values optional instance from which to copy values."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "values", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "concat", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Concatenates the values of properties in the <code>incoming</code> ITabStopFormat instance with the values of this TabStopFormat object. In this (the receiving) TabStopFormat object, properties whose values are <code>FormatValue.INHERIT</code>, and inheriting properties whose values are <code>undefined</code> will get new values from the <code>incoming</code> object. Non-inheriting properties whose values are <code>undefined</code> will get their default values. All other property values will remain unmodified.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["org.apache.royale.textLayout.formats.FormatValue#INHERIT"]}, | |
| { "tagName": "param", | |
| "values": ["incoming instance from which values are concatenated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "incoming", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "concatInheritOnly", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Concatenates the values of properties in the <code>incoming</code> ITabStopFormat instance with the values of this TabStopFormat object. In this (the receiving) TabStopFormat object, properties whose values are <code>FormatValue.INHERIT</code>, and inheriting properties whose values are <code>undefined</code> will get new values from the <code>incoming</code> object. All other property values will remain unmodified.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["org.apache.royale.textLayout.formats.FormatValue#INHERIT"]}, | |
| { "tagName": "param", | |
| "values": ["incoming instance from which values are concatenated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "incoming", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "apply", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Replaces property values in this TabStopFormat object with the values of properties that are set in the <code>incoming</code> ITabStopFormat instance. Properties that are <code>undefined</code> in the <code>incoming</code> ITabStopFormat instance are not changed in this object.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["incoming instance whose property values are applied to this TabStopFormat object."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "incoming", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "isEqual", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Compares properties in ITabStopFormat instance <code>p1</code> with properties in ITabStopFormat instance <code>p2</code> and returns <code>true</code> if all properties match.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["p1 instance to compare to <code>p2</code>.", "p2 instance to compare to <code>p1</code>."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["true if all properties match, false otherwise."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "p1", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}, | |
| { "name": "p2", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "removeMatching", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Sets properties in this TabStopFormat object to <code>undefined</code> if they match those in the <code>incoming</code> ITabStopFormat instance.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["incoming instance against which to compare this TabStopFormat object's property values."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "incoming", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "method", | |
| "qname": "removeClashing", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Sets properties in this TabStopFormat object to <code>undefined</code> if they do not match those in the <code>incoming</code> ITabStopFormat instance.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["incoming instance against which to compare this TabStopFormat object's property values."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "incoming", "type": "org.apache.royale.textLayout.formats.ITabStopFormat"}]} | |
| , | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "org.apache.royale.textLayout.formats.ITabStopFormat", | |
| "qname": "defaultFormat", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Returns a TabStopFormat object with default settings. This function always returns the same object.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["a singleton instance of ITabStopFormat that is populated with default values."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |