blob: ad54db331a8dec348bcfded328d311d0062132a6 [file]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<apiPackage id="mx.controls.menuClasses"><apiName>mx.controls.menuClasses</apiName><apiDetail/><apiClassifier id="mx.controls.menuClasses:IMenuDataDescriptor"><apiName>IMenuDataDescriptor</apiName><shortdesc>
IMenuDataDescriptor インターフェイスは、Menu または MenuBar コントロールの dataDescriptor が実装する必要があるインターフェイスを定義します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiInterface/><apiAccess value="public"/><apiStatic/><apiBaseClassifier/></apiClassifierDef><apiDesc>
IMenuDataDescriptor インターフェイスは、Menu または MenuBar コントロールの dataDescriptor が実装する必要があるインターフェイスを定義します。 このインターフェイスは、Menu コントロールまたは MenuBar コントロールによって表示されるデータのコレクションを解析および変更するメソッドを提供します。
</apiDesc></apiClassifierDetail><related-links><link href="mx.collections.xml#ICollectionView"><linktext>mx.collections.ICollectionView</linktext></link></related-links><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:addChildAt"><apiName>addChildAt</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#addChildAt()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>parent</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>newChild</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>index</apiItemName><apiType value="int"/></apiParam><apiParam><apiItemName>model</apiItemName><apiType value="Object"/><apiData>null</apiData></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#addChildAt()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:getChildren"><apiName>getChildren</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getChildren()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiOperationClassifier>mx.collections:ICollectionView</apiOperationClassifier></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>model</apiItemName><apiType value="Object"/><apiData>null</apiData></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getChildren()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:getData"><apiName>getData</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getData()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Object"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>model</apiItemName><apiType value="Object"/><apiData>null</apiData></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getData()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:getGroupName"><apiName>getGroupName</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getGroupName()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="String"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getGroupName()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:getType"><apiName>getType</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getType()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="String"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#getType()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:hasChildren"><apiName>hasChildren</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#hasChildren()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>model</apiItemName><apiType value="Object"/><apiData>null</apiData></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#hasChildren()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:isBranch"><apiName>isBranch</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#isBranch()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>model</apiItemName><apiType value="Object"/><apiData>null</apiData></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#isBranch()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:isEnabled"><apiName>isEnabled</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#isEnabled()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#isEnabled()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:isToggled"><apiName>isToggled</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#isToggled()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#isToggled()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:removeChildAt"><apiName>removeChildAt</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#removeChildAt()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="Boolean"/></apiReturn><apiParam><apiItemName>parent</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>child</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>index</apiItemName><apiType value="int"/></apiParam><apiParam><apiItemName>model</apiItemName><apiType value="Object"/><apiData>null</apiData></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#removeChildAt()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:setEnabled"><apiName>setEnabled</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#setEnabled()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>value</apiItemName><apiType value="Boolean"/></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#setEnabled()">
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.menuClasses:IMenuDataDescriptor:mx.controls.menuClasses:IMenuDataDescriptor:setToggled"><apiName>setToggled</apiName><shortdesc conref="mx.controls.treeClasses.DefaultDataDescriptor#setToggled()">
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>node</apiItemName><apiType value="Object"/></apiParam><apiParam><apiItemName>value</apiItemName><apiType value="Boolean"/></apiParam></apiOperationDef><apiDesc conref="mx.controls.treeClasses.DefaultDataDescriptor#setToggled()">
</apiDesc></apiOperationDetail></apiOperation></apiClassifier></apiPackage>