blob: 9f290aa73d81041962e044d238dc9c0b70930b13 [file] [log] [blame]
{ "type": "interface",
"qname": "mx.core.IUIComponent",
"baseInterfaceNames": [
"mx.core.IFlexDisplayObject",
"org.apache.royale.core.IChild",
"org.apache.royale.core.IUIBase",
"mx.core.IChildList"]
,
"description": "The IUIComponent interface defines the basic set of APIs that you must implement to create a child of a Flex container or list.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "mxmlDocument",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A reference to the document object associated with this component. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "enabled",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Whether the component can accept user interaction. After setting the <code>enabled</code> property to <code>false</code>, some components still respond to mouse interactions such as mouseOver. As a result, to fully disable UIComponents, you should also set the value of the <code>mouseEnabled</code> property to <code>false</code>. If you set the <code>enabled</code> property to <code>false</code> for a container, Flex dims the color of the container and of all of its children, and blocks user input to the container and to all of its children.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "explicitHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The explicitly specified height for the component, in pixels, as the component's coordinates. If no height is explicitly specified, the value is <code>NaN</code>.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#explicitHeight"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "explicitMaxHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the maximum height of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#explicitMaxHeight"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "explicitMaxWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the maximum width of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#explicitMaxWidth"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "explicitMinHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the minimum height of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#explicitMinHeight"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "explicitMinWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the minimum width of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#explicitMinWidth"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "explicitWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The explicitly specified width for the component, in pixels, as the component's coordinates. If no width is explicitly specified, the value is <code>NaN</code>.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#explicitWidth"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "includeInLayout",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#includeInLayout"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "isPopUp",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#isPopUp"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "maxHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the maximum height of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#maxHeight"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "maxWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the maximum width of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#maxWidth"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "measuredMinHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#measuredMinHeight"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "measuredMinWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#measuredMinWidth"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "minHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the minimum height of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#minHeight"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "minWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the minimum width of the component, in pixels, as the component's coordinates.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#minWidth"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.IUIComponent",
"qname": "owner",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.IVisualElement#owner"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "percentHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0 to 100.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "percentWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0 to 100.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "scaleX",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "scaleY",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "mx.managers.ISystemManager",
"qname": "systemManager",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A reference to the SystemManager object for this component.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "rotation",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "styleName",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}},
{ "type": "method",
"qname": "initialize",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Initialize the object.",
"tags": [
{ "tagName": "see",
"values": ["mx.core.UIComponent#initialize()"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "getExplicitOrMeasuredWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#getExplicitOrMeasuredWidth()"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Number",
"params": []}
,
{ "type": "method",
"qname": "getExplicitOrMeasuredHeight",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#getExplicitOrMeasuredHeight()"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Number",
"params": []}
,
{ "type": "method",
"qname": "owns",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.core.UIComponent#owns()"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Boolean",
"params": [{ "name": "displayObject", "type": "org.apache.royale.core.IUIBase"}]}
]
}