| { "type": "class", | |
| "qname": "mx.controls.Button", | |
| "baseClassname": "mx.core.UIComponent" | |
| , | |
| "description": "The Button control is a commonly used rectangular button. Button controls look like they can be pressed. They can have a text label, an icon, or both on their face. <p>Buttons typically use event listeners to perform an action when the user selects the control. When a user clicks the mouse on a Button control, and the Button control is enabled, it dispatches a <code>click</code> event and a <code>buttonDown</code> event. A button always dispatches events such as the <code>mouseMove</code>, <code>mouseOver</code>, <code>mouseOut</code>, <code>rollOver</code>, <code>rollOut</code>, <code>mouseDown</code>, and <code>mouseUp</code> events whether enabled or disabled.</p> <p>You can customize the look of a Button control and change its functionality from a push button to a toggle button. You can change the button appearance by using a skin for each of the button's states.</p> <p>The label of a Button control uses a bold typeface. If you embed a font that you want to use for the label of the Button control, you must embed the bold typeface; for example:</p> <pre>\\n <fx:style>\\n @font-face {\\n src:url("../MyFont-Bold.ttf");\\n fontFamily: myFont;\\n fontWeight: bold;\\n }\\n .myBoldStyle {\\n fontFamily: myFont;\\n fontWeight: bold;\\n }\\n </fx:style>\\n ...\\n <mx:Button ... styleName="myBoldStyle"/>\\n </pre> <p>The Button control has the following default characteristics:</p> <table class="innertable"> <tr><th>Characteristic</th><th>Description</th></tr> <tr><td>Default size</td><td>A size large enough to hold the label text, and any icon</td></tr> <tr><td>Minimum size</td><td>0 pixels</td></tr> <tr><td>Maximum size</td><td>No limit</td></tr> </table> <p>The <code><mx:Button></code> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:</p> <pre>\\n <mx:Button\\n <b>Properties</b>\\n autoRepeat="false|true"\\n emphasized="false|true"\\n fontContext="<i>IFontModuleFactory</i>"\\n label=""\\n labelPlacement="right|left|bottom|top"\\n selected="false|true"\\n selectedField="null"\\n stickyHighlighting="false|true"\\n toggle="false|true"\\n \\n <b>Styles</b>\\n borderColor="0xAAB3B3"\\n color="0x0B333C"\\n cornerRadius="4"\\n disabledColor="0xAAB3B3"\\n disabledIcon="null"\\n disabledSkin="mx.skins.halo.ButtonSkin"\\n downIcon="null"\\n downSkin="mx.skins.halo.ButtonSkin"\\n fillAlphas="[0.6, 0.4]"\\n fillColors="[0xE6EEEE, 0xFFFFFF]"\\n focusAlpha="0.5"\\n focusRoundedCorners"tl tr bl br"\\n fontAntiAliasType="advanced"\\n fontFamily="Verdana"\\n fontGridFitType="pixel"\\n fontSharpness="0"\\n fontSize="10"\\n fontStyle="normal|italic"\\n fontThickness="0"\\n fontWeight="bold|normal"\\n highlightAlphas="[0.3, 0.0]"\\n horizontalGap="2"\\n icon="null"\\n kerning="false|true"\\n leading="2"\\n letterSpacing="0"\\n overIcon="null"\\n overSkin="mx.skins.halo.ButtonSkin"\\n paddingBottom="2"\\n paddingLeft="0"\\n paddingRight="0"\\n paddingTop="2"\\n repeatDelay="500"\\n repeatInterval="35"\\n selectedDisabledIcon="null"\\n selectedDisabledSkin="mx.skins.halo.ButtonSkin"\\n selectedDownIcon="null"\\n selectedDownSkin="mx.skins.halo.ButtonSkin"\\n selectedOverIcon="null"\\n selectedOverSkin="mx.skins.halo.ButtonSkin"\\n selectedUpIcon="null"\\n selectedUpSkin="mx.skins.halo.ButtonSkin"\\n skin="mx.skins.halo.ButtonSkin"\\n textAlign="center|left|right"\\n textDecoration="none|underline"\\n textIndent="0"\\n textRollOverColor="0x2B333C"\\n textSelectedColor="0x000000"\\n upIcon="null"\\n upSkin="mx.skins.halo.ButtonSkin"\\n verticalGap="2"\\n \\n <b>Events</b>\\n buttonDown="<i>No default</i>"\\n change="<i>No default</i>"\\n dataChange="<i>No default</i>"\\n />\\n </pre>", | |
| "tags": [ | |
| { "tagName": "includeExample", | |
| "values": ["examples/ButtonExample.mxml"]}, | |
| { "tagName": "mxml", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.controls.Button", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "return": "", | |
| "params": []} | |
| , | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "locale", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "textDecoration", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "icon", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The URL of an icon to use in the button", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10.2", "AIR 2.6"]}, | |
| { "tagName": "productversion", | |
| "values": ["Royale 0.0"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "disabledIcon", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The URL of an disabledIcon to use in the button", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10.2", "AIR 2.6"]}, | |
| { "tagName": "productversion", | |
| "values": ["Royale 0.0"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "label", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "private", | |
| "values": []} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "toolTip", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Object", | |
| "qname": "data", | |
| "namespace": "public", | |
| "bindable": ["dataChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The <code>data</code> property lets you pass a value to the component when you use it as an item renderer or item editor. You typically use data binding to bind a field of the <code>data</code> property to a property of this component. <p>When you use the control as a drop-in item renderer or drop-in item editor, Flex automatically writes the current value of the item to the <code>selected</code> property of this control.</p> <p>You do not set this property in MXML.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["null"]}, | |
| { "tagName": "see", | |
| "values": ["mx.core.IDataRenderer"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "addBindingSupport", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "By default, ItemRendererDataBinding is added on-demand if an instance is used as a Drop-In Renderer But Button subclasses need to be able to add whatever binding support makes sense, and avoid the possibility of conflicting databinding support. Using this method in subclasses is one way to achieve that.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["bindingImplClass a class that is a subclass of DataBindingBase", "init true if the bindings should be initialized immediately"]} ], | |
| "return": "void", | |
| "params": [{ "name": "bindingImplClass", "type": "Class"}, | |
| { "name": "init", "type": "Boolean"}]} | |
| , | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Object", | |
| "qname": "listData", | |
| "namespace": "public", | |
| "bindable": ["dataChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the <code>listData</code> property of the component with the appropriate data from the list control. The component can then use the <code>listData</code> property to initialize the <code>data</code> property of the drop-in item renderer or drop-in item editor. <p>You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["null"]}, | |
| { "tagName": "see", | |
| "values": ["mx.controls.listClasses.IDropInListItemRenderer"]}, | |
| { "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": "selected", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "private", | |
| "values": []} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "labelPlacement", | |
| "namespace": "public", | |
| "bindable": ["labelPlacementChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Orientation of the label in relation to a specified icon. Valid MXML values are <code>right</code>, <code>left</code>, <code>bottom</code>, and <code>top</code>. <p>In ActionScript, you can use the following constants to set this property: <code>ButtonLabelPlacement.RIGHT</code>, <code>ButtonLabelPlacement.LEFT</code>, <code>ButtonLabelPlacement.BOTTOM</code>, and <code>ButtonLabelPlacement.TOP</code>.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["ButtonLabelPlacement.RIGHT"]}, | |
| { "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": "toggle", | |
| "namespace": "public", | |
| "bindable": ["toggleChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Controls whether a Button is in a toggle state or not. If <code>true</code>, clicking the button toggles it between a selected and an unselected state. You can get or set this state programmatically by using the <code>selected</code> property. If <code>false</code>, the button does not stay pressed after the user releases it. In this case, its <code>selected</code> property is always <code>false</code>. Buttons like this are used for performing actions. When <code>toggle</code> is set to <code>false</code>, <code>selected</code> is forced to <code>false</code> because only toggle buttons can be selected.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["false"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| , | |
| "events": [ | |
| { "qname": "click", | |
| "type": "mx.events.MouseEvent" | |
| , | |
| "description": "Dispatched when the user clicks on a button.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10.2", "AIR 2.6"]}, | |
| { "tagName": "productversion", | |
| "values": ["Royale 0.0"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "buttonDown", | |
| "type": "mx.events.FlexEvent" | |
| , | |
| "description": "Dispatched when the user presses the Button control. If the <code>autoRepeat</code> property is <code>true</code>, this event is dispatched repeatedly as long as the button stays down.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.FlexEvent.BUTTON_DOWN"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "change", | |
| "type": "org.apache.royale.events.Event" | |
| , | |
| "description": "Dispatched when the <code>selected</code> property changes for a toggle Button control. A toggle Button control means that the <code>toggle</code> property is set to <code>true</code>. For the RadioButton controls, this event is dispatched when the <code>selected</code> property changes. For the CheckBox controls, this event is dispatched only when the user interacts with the control by using the mouse.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["flash.events.Event.CHANGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "dataChange", | |
| "type": "mx.events.FlexEvent" | |
| , | |
| "description": "Dispatched when the <code>data</code> property changes. <p>When you use a component as an item renderer, the <code>data</code> property contains the data to display. You can listen for this event and update the component when the <code>data</code> property changes.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.FlexEvent.DATA_CHANGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |