blob: d78a40128edd39b81465acdf1d16c85ce4082d85 [file] [log] [blame]
{ "type": "class",
"qname": "mx.controls.ColorPicker",
"baseClassname": "mx.core.UIComponent"
,
"description": "The ColorPicker control provides a way for a user to choose a color from a swatch list. The default mode of the component shows a single swatch in a square button. When the user clicks the swatch button, the swatch panel appears and displays the entire swatch list. <p>The ColorPicker control has the following default sizing characteristics:</p> <table class=&quot;innertable&quot;> <tr> <th>Characteristic</th> <th>Description</th> </tr> <tr> <td>Default size</td> <td>ColorPicker: 22 by 22 pixels <br>Swatch panel: Sized to fit the ColorPicker control width</br></td> </tr> <tr> <td>Minimum size</td> <td>0 pixels by 0 pixels</td> </tr> <tr> <td>Maximum size</td> <td>Undefined</td> </tr> </table> <p>The <code>&lt;mx:ColorPicker&gt;</code> tag inherits all of the properties of its superclass, and the following properties:</p> <pre>\\n &lt;mx:ColorPicker\\n <b>Properties</b>\\n colorField=&quot;color&quot;\\n labelField=&quot;label&quot;\\n selectedColor=&quot;0x000000&quot;\\n selectedIndex=&quot;0&quot;\\n showTextField=&quot;true|false&quot;\\n \\n <b>Styles</b>\\n borderColor=&quot;0xA5A9AE&quot;\\n closeDuration=&quot;250&quot;\\n closeEasingFunction=&quot;undefined&quot;\\n color=&quot;0x0B333C&quot;\\n disabledIconColor=&quot;0x999999&quot;\\n fillAlphas=&quot;[0.6,0.4]&quot;\\n fillColors=&quot;[0xFFFFFF, 0xCCCCCC]&quot;\\n focusAlpha=&quot;0.5&quot;\\n focusRoundedCorners=&quot;tl tr bl br&quot;\\n fontAntiAliasType=&quot;advanced&quot;\\n fontfamily=&quot;Verdana&quot;\\n fontGridFitType=&quot;pixel&quot;\\n fontSharpness=&quot;0&quot;&quot;\\n fontSize=&quot;10&quot;\\n fontStyle=&quot;normal&quot;\\n fontThickness=&quot;0&quot;\\n fontWeight=&quot;normal&quot;\\n highlightAlphas=&quot;[0.3,0.0]&quot;\\n iconColor=&quot;0x000000&quot;\\n leading=&quot;2&quot;\\n openDuration=&quot;250&quot;\\n openEasingFunction=&quot;undefined&quot;\\n paddingBottom=&quot;5&quot;\\n paddingLeft=&quot;5&quot;\\n paddingRight=&quot;5&quot;\\n paddingTop=&quot;4&quot;\\n swatchBorderColor=&quot;0x000000&quot;\\n swatchBorderSize=&quot;1&quot;\\n swatchPanelStyleName=&quot;undefined&quot;\\n textAlign=&quot;left&quot;\\n textDecoration=&quot;none&quot;\\n textIndent=&quot;0&quot;\\n \\n <b>Events</b>\\n change=&quot;<i>No default</i>&quot;\\n close=&quot;<i>No default</i>&quot;\\n enter=&quot;<i>No default</i>&quot;\\n itemRollOut=&quot;<i>No default</i>&quot;\\n itemRollOver=&quot;<i>No default</i>&quot;\\n open=&quot;<i>No default</i>&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "includeExample",
"values": ["examples/ColorPickerExample.mxml"]},
{ "tagName": "see",
"values": ["mx.controls.List", "mx.effects.Tween", "mx.managers.PopUpManager"]},
{ "tagName": "helpid",
"values": ["4917"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.controls.ColorPicker",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "showTextField",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies whether to show the text box that displays the color label or hexadecimal color value.",
"tags": [
{ "tagName": "default",
"values": ["true"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "uint",
"qname": "selectedColor",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The value of the currently selected color in the SwatchPanel object. In the &lt;mx:ColorPicker&gt; tag only, you can set this property to a standard string color name, such as &quot;blue&quot;. If the dataProvider contains an entry for black (0x000000), the default value is 0; otherwise, the default value is the color of the item at index 0 of the data provider.",
"tags": [
{ "tagName": "helpid",
"values": ["4932"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "selectedItem",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {}}]
,
"events": [
{ "qname": "change",
"type": "mx.events.ColorPickerEvent"
,
"description": "Dispatched when the selected color changes as a result of user interaction.",
"tags": [
{ "tagName": "helpid",
"values": ["4918"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["mx.events.ColorPickerEvent.CHANGE"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "qname": "close",
"type": "org.apache.royale.events.Event"
,
"description": "Dispatched when the swatch panel closes.",
"tags": [
{ "tagName": "helpid",
"values": ["4921"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["mx.events.DropdownEvent.CLOSE"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}