blob: 21f6cab783b7dad630b671d518d45df74dd6854e [file] [log] [blame]
<?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.printing"><apiName>mx.printing</apiName><apiDetail/><apiClassifier id="mx.printing:PrintDataGrid"><apiName>PrintDataGrid</apiName><shortdesc>
Элемент управления PrintDataGrid является подклассом DataGrid, предназначенным для отображения таблицы с границами строк и оптимизированным для печати.</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><Exclude kind="effect" name="showEffect"/><Exclude kind="effect" name="rollOverEffect"/><Exclude kind="effect" name="rollOutEffect"/><Exclude kind="effect" name="resizeEffect"/><Exclude kind="effect" name="removedEffect"/><Exclude kind="effect" name="moveEffect"/><Exclude kind="effect" name="mouseUpEffect"/><Exclude kind="effect" name="mouseDownEffect"/><Exclude kind="effect" name="hideEffect"/><Exclude kind="effect" name="focusOutEffect"/><Exclude kind="effect" name="focusInEffect"/><Exclude kind="effect" name="creationCompleteEffect"/><Exclude kind="effect" name="addedEffect"/><Exclude kind="style" name="verticalScrollBarStyleName"/><Exclude kind="style" name="useRollOver"/><Exclude kind="style" name="textSelectedColor"/><Exclude kind="style" name="textRollOverColor"/><Exclude kind="style" name="strechCursor"/><Exclude kind="style" name="selectionEasingFunction"/><Exclude kind="style" name="selectionDuration"/><Exclude kind="style" name="selectionDisabledColor"/><Exclude kind="style" name="selectionColor"/><Exclude kind="style" name="rollOverColor"/><Exclude kind="style" name="horizontalScrollBarStyleName"/><Exclude kind="style" name="headerDragProxyStyleName"/><Exclude kind="style" name="dropIndicatorSkin"/><Exclude kind="style" name="columnResizeSkin"/><Exclude kind="style" name="columnDropIndicatorSkin"/><Exclude kind="event" name="toolTipStart"/><Exclude kind="event" name="toolTipShown"/><Exclude kind="event" name="toolTipShow"/><Exclude kind="event" name="toolTipHide"/><Exclude kind="event" name="toolTipEnd"/><Exclude kind="event" name="toolTipCreate"/><Exclude kind="event" name="rollOver"/><Exclude kind="event" name="rollOut"/><Exclude kind="event" name="mouseWheelOutside"/><Exclude kind="event" name="mouseWheel"/><Exclude kind="event" name="mouseUp"/><Exclude kind="event" name="mouseOver"/><Exclude kind="event" name="mouseOut"/><Exclude kind="event" name="mouseMove"/><Exclude kind="event" name="mouseFocusChange"/><Exclude kind="event" name="mouseDownOutside"/><Exclude kind="event" name="mouseDown"/><Exclude kind="event" name="keyUp"/><Exclude kind="event" name="keyDown"/><Exclude kind="event" name="itemRollOver"/><Exclude kind="event" name="itemRollOut"/><Exclude kind="event" name="itemFocusOut"/><Exclude kind="event" name="itemFocusIn"/><Exclude kind="event" name="itemEditEnd"/><Exclude kind="event" name="itemEditBeginning"/><Exclude kind="event" name="itemEditBegin"/><Exclude kind="event" name="itemDoubleClick"/><Exclude kind="event" name="itemClick"/><Exclude kind="event" name="headerRelease"/><Exclude kind="event" name="effectStart"/><Exclude kind="event" name="effectEnd"/><Exclude kind="event" name="dragOver"/><Exclude kind="event" name="dragExit"/><Exclude kind="event" name="dragEnter"/><Exclude kind="event" name="dragDrop"/><Exclude kind="event" name="dragComplete"/><Exclude kind="event" name="doubleClick"/><Exclude kind="event" name="click"/><Exclude kind="method" name="setScrollBarProperties"/><Exclude kind="method" name="selectItem"/><Exclude kind="method" name="removeIndicators"/><Exclude kind="method" name="placeSortArrow"/><Exclude kind="method" name="moveSelectionVertically"/><Exclude kind="method" name="moveSelectionHorizontally"/><Exclude kind="method" name="mouseWheelHandler"/><Exclude kind="method" name="mouseUpHandler"/><Exclude kind="method" name="mouseOverHandler"/><Exclude kind="method" name="mouseOutHandler"/><Exclude kind="method" name="mouseMoveHandler"/><Exclude kind="method" name="mouseEventToItemRenderer"/><Exclude kind="method" name="mouseDownHandler"/><Exclude kind="method" name="mouseDoubleClickHandler"/><Exclude kind="method" name="mouseClickHandler"/><Exclude kind="method" name="drawSelectionIndicator"/><Exclude kind="method" name="drawHighlightIndicator"/><Exclude kind="method" name="drawCaretIndicator"/><Exclude kind="method" name="dragScroll"/><Exclude kind="method" name="dragOverHandler"/><Exclude kind="method" name="dragExitHandler"/><Exclude kind="method" name="dragEnterHandler"/><Exclude kind="method" name="dragDropHandler"/><Exclude kind="method" name="dragCompleteHandler"/><Exclude kind="method" name="startDrag"/><Exclude kind="method" name="showDropFeedback"/><Exclude kind="method" name="isItemSelected"/><Exclude kind="method" name="isItemHighlighted"/><Exclude kind="method" name="hideDropFeedback"/><Exclude kind="method" name="endEffectStarted"/><Exclude kind="method" name="effectStarted"/><Exclude kind="method" name="effectFinished"/><Exclude kind="method" name="destroyItemEditor"/><Exclude kind="method" name="createItemEditor"/><Exclude kind="method" name="calculateDropIndex"/><Exclude kind="property" name="showCaret"/><Exclude kind="property" name="selectionTweens"/><Exclude kind="property" name="selectionLayer"/><Exclude kind="property" name="lastDropIndex"/><Exclude kind="property" name="keySelectionPending"/><Exclude kind="property" name="highlightUID"/><Exclude kind="property" name="highlightIndicator"/><Exclude kind="property" name="dragImageOffsets"/><Exclude kind="property" name="dragImage"/><Exclude kind="property" name="caretUID"/><Exclude kind="property" name="caretItemRenderer"/><Exclude kind="property" name="caretIndicator"/><Exclude kind="property" name="caretIndex"/><Exclude kind="property" name="caretBookmark"/><Exclude kind="property" name="anchorIndex"/><Exclude kind="property" name="anchorBookmark"/><Exclude kind="property" name="verticalScrollPolicy"/><Exclude kind="property" name="verticalScrollBar"/><Exclude kind="property" name="useHandCursor"/><Exclude kind="property" name="toolTip"/><Exclude kind="property" name="showScrollTips"/><Exclude kind="property" name="selectedItems"/><Exclude kind="property" name="selectedItem"/><Exclude kind="property" name="selectedIndices"/><Exclude kind="property" name="selectedIndex"/><Exclude kind="property" name="selectable"/><Exclude kind="property" name="scrollTipFunction"/><Exclude kind="property" name="maxVerticalScrollPosition"/><Exclude kind="property" name="maxHorizontalScrollPosition"/><Exclude kind="property" name="horizontalScrollPolicy"/><Exclude kind="property" name="horizontalScrollBar"/><Exclude kind="property" name="editedItemRenderer"/><Exclude kind="property" name="editedItemPosition"/><Exclude kind="property" name="editable"/><Exclude kind="property" name="dropTarget"/><Exclude kind="property" name="dropEnabled"/><Exclude kind="property" name="dragMoveEnabled"/><Exclude kind="property" name="draggableColumns"/><Exclude kind="property" name="dragEnabled"/><Exclude kind="property" name="doubleClickEnabled"/><Exclude kind="property" name="dataTipFunction"/><Exclude kind="property" name="dataTipField"/><Exclude kind="property" name="allowMultipleSelection"/><Exclude kind="property" name="allowDragSelection"/><DefaultProperty name="dataProvider"/></asMetadata><asCustoms><mxml><![CDATA[
<p>The <code>&lt;mx:PrintDataGrid&gt;</code> tag inherits the tag attributes
of its superclass; however, you do not use the properties, styles, events,
and effects (or methods) associated with user interaction.
The <code>&lt;mx:PrintDataGrid&gt;</code> tag adds the following tag attribute:
</p>
<pre>
&lt;mx:PrintDataGrid
<b>Properties</b>
sizeToPage="true|false"
&gt;
...
&lt;/mx:PrintDataGrid&gt;
</pre>
]]></mxml></asCustoms></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>mx.controls:DataGrid</apiBaseClassifier></apiClassifierDef><apiDesc>
Элемент управления PrintDataGrid является подклассом DataGrid, предназначенным для отображения таблицы с границами строк и оптимизированным для печати. Он обеспечивает автоматическое изменение собственного размера в соответствии с размером контейнера и удаление любых частично отображаемых строк.
</apiDesc><example conref="FormPrintHeader.mxml"/><example conref="FormPrintFooter.mxml"/><example conref="FormPrintView.mxml"/><example conref="PrintDataGridExample.mxml"><swfblock conref="examples/PrintDataGridExample.swf"/></example></apiClassifierDetail><related-links><link href="" invalidHref="mx.printing.FlexPrintJob.xml"><linktext>FlexPrintJob</linktext></link></related-links><apiConstructor id="mx.printing:PrintDataGrid:PrintDataGrid"><apiName>PrintDataGrid</apiName><shortdesc>
Конструктор.</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><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/></apiConstructorDef><apiDesc>
Конструктор.
<p>Создает элемент DataGrid без полос прокрутки или взаимодействия с пользователем, сортировки столбцов, изменения размеров, перетаскиваемой прокрутки, выбора или использования клавиатуры. Высота по умолчанию равна наименьшему значению из 100 % от высоты контейнера и высоты, требуемой для отображения всех строк dataProvider.</p>
</apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="mx.printing:PrintDataGrid:nextPage"><apiName>nextPage</apiName><shortdesc>
Обеспечивает размещение следующего набора строк в представлении, т. е. устанавливает значение, равное сумме verticalScrollPosition + (количество прокручиваемых строк), для свойства verticalScrollPosition элемента PrintDataGrid.</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></apiOperationDef><apiDesc>
Обеспечивает размещение следующего набора строк в представлении, т. е. устанавливает значение, равное сумме <codeph>verticalScrollPosition</codeph> + (количество прокручиваемых строк), для свойства <codeph>verticalScrollPosition</codeph> элемента PrintDataGrid.
</apiDesc></apiOperationDetail></apiOperation><apiValue id="mx.printing:PrintDataGrid:sizeToPage"><apiName>sizeToPage</apiName><shortdesc>
Если значение равно true, элемент PrintDataGrid обеспечивает корректировку собственной высоты для отображения только полностью видимых строк.</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><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiData>true</apiData><apiType value="Boolean"/></apiValueDef><apiDesc>
Если значение равно <codeph>true</codeph>, элемент PrintDataGrid обеспечивает корректировку собственной высоты для отображения только полностью видимых строк.
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.printing:PrintDataGrid:currentPageHeight:get"><apiName>currentPageHeight</apiName><shortdesc>
Высота элемента PrintDataGrid в том случае, если свойство sizeToPage имеет значение true, и в элементе PrintDataGrid отображаются только полностью видимые строки, а неполные строки не выводятся на экран.</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><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="Number"/></apiValueDef><apiDesc>
Высота элемента PrintDataGrid в том случае, если свойство <codeph>sizeToPage</codeph> имеет значение <codeph>true</codeph> и в элементе PrintDataGrid отображаются только полностью видимые строки, а неполные строки не выводятся на экран. Если свойство <codeph>sizeToPage</codeph> имеет значение <codeph>true</codeph>, значение этого свойства равняется значению свойства <codeph>height</codeph>.
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.printing:PrintDataGrid:originalHeight:get"><apiName>originalHeight</apiName><shortdesc>
Высота PrintDataGrid, определенная пользователем.</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><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="Number"/></apiValueDef><apiDesc>
Высота PrintDataGrid, определенная пользователем. Если свойство <codeph>sizeToPage</codeph> имеет значение <codeph>false</codeph>, значение этого свойства равняется значению свойства <codeph>height</codeph>.
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.printing:PrintDataGrid:validNextPage:get"><apiName>validNextPage</apiName><shortdesc>
Указывает на то, что в поставщике данных содержатся дополнительные строки данных, расположенные после строк, отображаемых элементом управления PrintDataGrid в текущий момент.</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><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="Boolean"/></apiValueDef><apiDesc>
Указывает на то, что в поставщике данных содержатся дополнительные строки данных, расположенные после строк, отображаемых элементом управления PrintDataGrid в текущий момент.
</apiDesc></apiValueDetail></apiValue></apiClassifier></apiPackage>