{ "type": "class", | |
"qname": "org.apache.royale.textLayout.compose.ParcelList", | |
"baseClassname": "" | |
, | |
"description": "@private Used for composing text containers, keeps track of the areas that text in the flow is composed into. ParcelList will always have one parcel, which corresponds to the container's bounding box.", | |
"members": [ | |
{ "type": "field", | |
"qname": "_flowComposer", | |
"return": "org.apache.royale.textLayout.compose.IFlowComposer", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_totalDepth", | |
"return": "Number", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Current vertical position in the parcel."}, | |
{ "type": "field", | |
"qname": "_hasContent", | |
"return": "Boolean", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "whether the current parcel has any content"}, | |
{ "type": "field", | |
"qname": "_parcelArray", | |
"return": "Array", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "The list of parcels that are available for text layout."}, | |
{ "type": "field", | |
"qname": "_numParcels", | |
"return": "int", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_singleParcel", | |
"return": "org.apache.royale.textLayout.compose.Parcel", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_currentParcelIndex", | |
"return": "int", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Index of the "current" parcel. These next two variables must be kept in sync."}, | |
{ "type": "field", | |
"qname": "_currentParcel", | |
"return": "org.apache.royale.textLayout.compose.Parcel", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_insideListItemMargin", | |
"return": "Number", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_leftMargin", | |
"return": "Number", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_rightMargin", | |
"return": "Number", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_explicitLineBreaks", | |
"return": "Boolean", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "field", | |
"qname": "_verticalText", | |
"return": "Boolean", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "True if text is vertical (as for some Japanese & Chinese, false otherwise"}, | |
{ "type": "method", | |
"qname": "org.apache.royale.textLayout.compose.ParcelList", | |
"namespace": "", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Constructor.", | |
"return": "", | |
"params": []} | |
, | |
{ "type": "method", | |
"qname": "getParcelAt", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "org.apache.royale.textLayout.compose.Parcel", | |
"params": [{ "name": "idx", "type": "int"}]} | |
, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "int", | |
"qname": "currentParcelIndex", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "Boolean", | |
"qname": "explicitLineBreaks", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "Number", | |
"qname": "totalDepth", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "method", | |
"qname": "addTotalDepth", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Number", | |
"params": [{ "name": "value", "type": "Number"}]} | |
, | |
{ "type": "method", | |
"qname": "reset", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": []} | |
, | |
{ "type": "method", | |
"qname": "addParcel", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "org.apache.royale.textLayout.compose.Parcel", | |
"params": [{ "name": "column", "type": "org.apache.royale.geom.Rectangle"}, | |
{ "name": "controller", "type": "org.apache.royale.textLayout.container.IContainerController"}, | |
{ "name": "columnIndex", "type": "int"}]} | |
, | |
{ "type": "method", | |
"qname": "numParcels", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "int", | |
"params": []} | |
, | |
{ "type": "method", | |
"qname": "popParcel", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "org.apache.royale.textLayout.compose.Parcel", | |
"params": []} | |
, | |
{ "type": "method", | |
"qname": "addTableCell2ColumnState", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "controller", "type": "org.apache.royale.textLayout.container.IContainerController"}, | |
{ "name": "cell", "type": "org.apache.royale.textLayout.elements.TableCellElement"}]} | |
, | |
{ "type": "method", | |
"qname": "addOneControllerToParcelList", | |
"namespace": "protected", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "controllerToInitialize", "type": "org.apache.royale.textLayout.container.IContainerController"}]} | |
, | |
{ "type": "method", | |
"qname": "beginCompose", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "composer", "type": "org.apache.royale.textLayout.compose.IFlowComposer"}, | |
{ "name": "controllerStartIndex", "type": "int"}, | |
{ "name": "controllerEndIndex", "type": "int"}, | |
{ "name": "composeToPosition", "type": "Boolean"}]} | |
, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "Number", | |
"qname": "leftMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "method", | |
"qname": "pushLeftMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "leftMargin", "type": "Number"}]} | |
, | |
{ "type": "method", | |
"qname": "popLeftMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "leftMargin", "type": "Number"}]} | |
, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "Number", | |
"qname": "rightMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "method", | |
"qname": "pushRightMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "rightMargin", "type": "Number"}]} | |
, | |
{ "type": "method", | |
"qname": "popRightMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "rightMargin", "type": "Number"}]} | |
, | |
{ "type": "method", | |
"qname": "pushInsideListItemMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "margin", "type": "Number"}]} | |
, | |
{ "type": "method", | |
"qname": "popInsideListItemMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "void", | |
"params": [{ "name": "margin", "type": "Number"}]} | |
, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "Number", | |
"qname": "insideListItemMargin", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "method", | |
"qname": "getComposeXCoord", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Number", | |
"params": [{ "name": "o", "type": "org.apache.royale.geom.Rectangle"}]} | |
, | |
{ "type": "method", | |
"qname": "getComposeYCoord", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Number", | |
"params": [{ "name": "o", "type": "org.apache.royale.geom.Rectangle"}]} | |
, | |
{ "type": "method", | |
"qname": "getComposeWidth", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Number", | |
"params": [{ "name": "o", "type": "org.apache.royale.geom.Rectangle"}]} | |
, | |
{ "type": "method", | |
"qname": "getComposeHeight", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Number", | |
"params": [{ "name": "o", "type": "org.apache.royale.geom.Rectangle"}]} | |
, | |
{ "type": "method", | |
"qname": "atLast", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Returns true if the current parcel is the last.", | |
"return": "Boolean", | |
"params": []} | |
, | |
{ "type": "method", | |
"qname": "atEnd", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Boolean", | |
"params": []} | |
, | |
{ "type": "method", | |
"qname": "gotoParcel", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Boolean", | |
"params": [{ "name": "index", "type": "int"}, | |
{ "name": "depth", "type": "Number"}]} | |
, | |
{ "type": "method", | |
"qname": "next", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Boolean", | |
"params": []} | |
, | |
{ "type": "accessor", | |
"access": "read-only", | |
"return": "org.apache.royale.textLayout.compose.Parcel", | |
"qname": "currentParcel", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}}, | |
{ "type": "method", | |
"qname": "getLineSlug", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Return the slug rectangle for a line that goes at the current vertical location, and could extend down for at least height pixels. Note that this function can change the current parcel, and the location within the parcel.", | |
"tags": [ | |
{ "tagName": "param", | |
"values": ["slugRect result rectangle where line was fit", "height amount of contiguous vertical space that must be available", "minWidth amount of contiguous horizontal space that must be available"]}, | |
{ "tagName": "return", | |
"values": ["true if a line slug was fit horizontal space actually available"]} ], | |
"return": "Boolean", | |
"params": [{ "name": "slug", "type": "org.apache.royale.textLayout.compose.Slug"}, | |
{ "name": "height", "type": "Number"}, | |
{ "name": "minWidth", "type": "Number"}, | |
{ "name": "textIndent", "type": "Number"}, | |
{ "name": "directionLTR", "type": "Boolean"}]} | |
, | |
{ "type": "method", | |
"qname": "fitFloat", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"return": "Boolean", | |
"params": [{ "name": "slug", "type": "org.apache.royale.textLayout.compose.Slug"}, | |
{ "name": "totalDepth", "type": "Number"}, | |
{ "name": "width", "type": "Number"}, | |
{ "name": "height", "type": "Number"}]} | |
] | |
} |