blob: b36aa5c79f9dcfc1aa84fef72447275aa425f194 [file] [log] [blame]
{ "type": "class",
"qname": "org.apache.royale.icons.FontAwesomeIcon",
"baseClassname": "org.apache.royale.icons.FontIconBase"
,
"description": "Icons can be used alone or in buttons and other controls This class could be used with any icon family out there and with its text property",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "field",
"qname": "v",
"return": "Number",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "FontAwesome version (4,5,...) Warning: Creators of FontAwesome not recommend using Font Awesome 4 and 5 side-by-side on the smae project"},
{ "type": "field",
"qname": "BRANDS",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Icon Styles for Font Awesome 5. Free version has Brands and Solid Pro version adds Regular, light and Duotone"},
{ "type": "field",
"qname": "SOLID",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "REGULAR",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "LIGHT",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "DUOTONE",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "method",
"qname": "org.apache.royale.icons.FontAwesomeIcon",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "constructor. <inject_script> var link = document.createElement(&quot;link&quot;); link.setAttribute(&quot;rel&quot;, &quot;stylesheet&quot;); link.setAttribute(&quot;type&quot;, &quot;text/css&quot;); link.setAttribute(&quot;href&quot;, &quot;https://pro.fontawesome.com/releases/v5.13.0/css/all.css&quot;); document.head.appendChild(link); </inject_script>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "method",
"qname": "addedToParent",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "The method called when added to a parent.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.6"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "setUpClassName",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "update font awesome style.",
"return": "void",
"params": []}
,
{ "type": "field",
"qname": "_faStyle",
"return": "String",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "field",
"qname": "_oldFaStyle",
"return": "String",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "faStyle",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "the font awesome 5 style. Can be one of the following constants defined in this class: - BRANDS (b); - SOLID (s); - REGULAR (r) - this is the default; - LIGHT (l); - DUOTONE (d); Only available for v (version) = 5 For version 4, style is always the same and you must different type values.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "text",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "the icon type. This field is required.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_pullRight",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "pullRight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "pullRight makes pull to the right, needs border = true",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_pullLeft",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "pullLeft",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "pullLeft makes pull to the left, needs border = true",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_border",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "border",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Show a border around the icon",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "SIZE_LG",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "SIZE_X2",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "SIZE_X3",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "SIZE_X4",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "SIZE_X5",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "_relativeSize",
"return": "String",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "relativeSize",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Increase icon sizes relative to their container, use the lg (33% increase), 2x, 3x, 4x, or 5x.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_fixedWidth",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "fixedWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Set icons at a fixed width. Great to use when different icon widths throw off alignment. Especially useful in things like nav lists & list groups.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_flipHorizontal",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "flipHorizontal",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Flip the icon horizontal",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_flipVertical",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "flipVertical",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Flip the icon vertical",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "ROTATE_90",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "ROTATE_180",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "ROTATE_270",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {}},
{ "type": "field",
"qname": "_spin",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "spin",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Spin the icon (full 360ยบ rotation animation)",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "_pulse",
"return": "Boolean",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "pulse",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Pulse the icon (8 step rotation animation)",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.7"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}