asdoc/org/apache/royale/textLayout/elements/IConfiguration.swf.json

{ "type": "interface",
  "qname": "org.apache.royale.textLayout.elements.IConfiguration",
    "description": "Read-only interface to a configuration object.  Used by TextFlow to guarantee it has an unchangeable configuration once its constructed.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "clone",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Creates a writeable clone of the IConfiguration object.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "org.apache.royale.textLayout.elements.IConfiguration",
      "params": []}
  ,
  { "type": "accessor",
    "access": "read-only",
    "return": "Boolean",
    "qname": "manageTabKey",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies whether the TAB key is entered as text by Text Layout Framework, or Flash Player or AIR handles it and turns it into a tabbed panel event.  <p>Default value is <code>false</code>.</p>",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Boolean",
    "qname": "manageEnterKey",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies whether the Enter / Return key is entered as text by Text Layout Framework, to split a paragraph for example, or the client code handles it. The client code might handle it by committing a form that has a default button for that purpose, for example.  <p>Default value is <code>true</code>.</p>",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "int",
    "qname": "shiftEnterLevel",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Determines how shift-enter is treated. Shift-enter can be treated as a soft return or hard return. There are three possible levels. Level 0 means all shift-returns will be hard returns. Level 1 means shift-returns inside lists will be treated as hard returns. Otherwise they will be treated as hard returns. Level 2 means all shift-returns will be treated as soft returns.  <p>Default value is <code>2</code>.</p>",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "String",
    "qname": "overflowPolicy",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Policy used for deciding whether the last line of a container fits in the container, or whether it overflows. Use the constants of the OverflowPolicy class to set this property.  <p>Default value is OverflowPolicy.FIT_DESCENDERS, which fits the line in the composition area if the area from the top to the baseline fits.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["OverflowPolicy"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Boolean",
    "qname": "enableAccessibility",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies whether accessibility support is turned on or not.  If <code>true</code>, screen readers can read the TextFlow contents.  <p>Default value is <code>false</code>.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["TextFlow"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.formats.ITextLayoutFormat",
    "qname": "defaultLinkNormalFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the initial link attributes for all LinkElement objects in the text flow. These are default values for new LinkElement objects that don't specify values for these attributes.  The default normal format displays the link in blue with underlining.",
    "tags": [
    {  "tagName": "see",
           "values": ["FlowElement#linkNormalFormat", "org.apache.royale.textLayout.formats.ITextLayoutFormat ITextLayoutFormat", "LinkElement"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.formats.ITextLayoutFormat",
    "qname": "defaultLinkHoverFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when the cursor hovers over it. These are defaults for new LinkElement objects that don't specify values for these attributes.  <p>Default is <code>null</code>.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["FlowElement#linkHoverFormat", "org.apache.royale.textLayout.formats.ITextLayoutFormat ITextLayoutFormat", "LinkElement"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.formats.ITextLayoutFormat",
    "qname": "defaultLinkActiveFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text flow. These are defaults for new LinkElement objects that don't specify values for these attributes.  <p>Default is <code>null</code>.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["FlowElement#linkActiveFormat", "org.apache.royale.textLayout.formats.ITextLayoutFormat ITextLayoutFormat", "LinkElement"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.formats.IListMarkerFormat",
    "qname": "defaultListMarkerFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the active character format attributes that initially apply for all ListItems in the text flow. These are defaults for new ListItemElements objects that don't specify values for these attributes.  <p>Default is <code>null</code>.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["FlowElement#linkActiveFormat", "org.apache.royale.textLayout.formats.ITextLayoutFormat ITextLayoutFormat", "LinkElement"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "org.apache.royale.textLayout.formats.ITextLayoutFormat",
    "qname": "textFlowInitialFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the initial format TextLayoutFormat configuration for a text flow (TextFlow object).  <p>Default is <code>null</code>.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["TextFlow", "org.apache.royale.textLayout.formats.ITextLayoutFormat ITextLayoutFormat"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.edit.SelectionFormat",
    "qname": "focusedSelectionFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus. Text Layout Framework uses <code>focusedSelectionFormat</code> to draw the selection when the window is active and one of the containers in the TextFlow has focus. You can override this format using <code>SelectionManager.focusedSelectionFormat</code>, if desired.  <p>The SelectionFormat class specifies the default values, which invert the color of the text and its background.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.edit.SelectionFormat SelectionFormat", "org.apache.royale.textLayout.edit.SelectionManager#focusedSelectionFormat SelectionManager.focusedSelectionFormat", "TextFlow"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.edit.SelectionFormat",
    "qname": "unfocusedSelectionFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The initial selection format that Text Layout Framework uses to draw the selection when the window is active but none of the containers in the TextFlow have focus. You can override this format using <code>SelectionManager.unfocusedSelectionFormat</code>, if desired.  <p>If you do not override <code>unfocusedSelectionFormat</code> the SelectionFormat values used are:</p>  <ul> <li><code>color = 0xffffff</code> (white)</li> <li><code>alpha = 0</code></li> <li><code>blendMode = flash.display.BlendMode.DIFFERENCE</code></li> </ul> <p>The result is no selection is displayed.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.edit.SelectionFormat SelectionFormat", "org.apache.royale.textLayout.edit.SelectionManager#unfocusedSelectionFormat SelectionManager.unfocusedSelectionFormat", "TextFlow"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "org.apache.royale.textLayout.edit.SelectionFormat",
    "qname": "inactiveSelectionFormat",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. Text Layout Framework uses <code>inactiveSelectionFormat</code> for drawing the selection when the window is inactive. You can override this format using <code>SelectionManager.inactiveSelectionFormat</code>, if desired.  <p>If you do not override <code>unfocusedSelectionFormat</code> the SelectionFormat values used are:</p> <ul> <li><code>color = 0xffffff</code> (white)</li> <li><code>alpha = 0</code></li> <li><code>blendMode = flash.display.BlendMode.DIFFERENCE</code></li> </ul> <p>The result is no selection is displayed.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.edit.SelectionFormat SelectionFormat", "org.apache.royale.textLayout.edit.SelectionManager#inactiveSelectionFormat SelectionManager.inactiveSelectionFormat", "TextFlow"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Number",
    "qname": "scrollDragDelay",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies a timed delay between one scroll and the next to prevent scrolling from going too fast. This value specifies what the delay is in milliseconds. The default value is 35.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Number",
    "qname": "scrollDragPixels",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging the selection. Default value is 20.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Number",
    "qname": "scrollPagePercentage",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the default percentage of the text flow to scroll for page scrolls. Default value is 7.0 / 8.0, or .875.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Number",
    "qname": "scrollMouseWheelMultiplier",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the default number of pixels to scroll for Mouse wheel events. Default value is 20.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Class",
    "qname": "flowComposerClass",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the type of flow composer to attach to a new TextFlow object by default. Default value is StandardFlowComposer.",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.compose.StandardFlowComposer StandardFlowComposer", "org.apache.royale.textLayout.elements.TextFlow TextFlow"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Boolean",
    "qname": "releaseLineCreationData",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Requests that the process of composing text release line creation data after composing each paragraph. This request saves memory but slows down the composing process.  <p>Default value is <code>false</code>.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.compose.StandardFlowComposer StandardFlowComposer", "org.apache.royale.text.engine.TextBlock#releaseLineCreationData() TextBlock.releaseLineCreationData()"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Function",
    "qname": "inlineGraphicResolverFunction",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the callback used for resolving an inline graphic element. The callback takes a <code>org.apache.royale.textLayout.elements.InlineGraphicElement</code> object and returns the value to be used as the element's <code>org.apache.royale.textLayout.elements.InlineGraphicElement#source</code>.  This callback provides the mechanism to delay providing an inline graphic element's source until just before it is composed. <p><strong>Note:</strong> this callback will be invoked only if a placeholder source of String type is already set. Moreover, it may be invoked multiple times. </p>",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.elements.InlineGraphicElement InlineGraphicElement"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Function",
    "qname": "cursorFunction",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Specifies the callback used for custom cursor. The callback takes a <code>String</code> object, string is cursor name and returns the value to be used in MouseCursor.cursor.  This callback provides the user to customize the cursor",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "getImmutableClone",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "return": "org.apache.royale.textLayout.elements.IConfiguration",
      "params": []}
  ]
  }