ga.model

# PanelRichText - AS3 ADEP Guides

Package | ga.model
Class | public class PanelRichText
Inheritance | PanelRichText AccessibleRichText
Implements | IPanelText

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

The `PanelText` class defines the Guide Text Guide object that contains text and can be bound to the form model. The Guide Text object is added into a panel layout in the same manner as an object.

The `PanelText` class extends the `<mx:Text>` component so that it will inherit the appropriate behaviors.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The properties for the `PanelText` class when acting as a a run-time component in a panel layout. These are in addition to the properties inherited from the `<mx:Text>` component.

    	  <ga:PanelText
    	   Properties
    	   caption=""
    	   captionWidth=""
    	   toolTip=""
    	   helpText=""
    	   speak=""
    	   dataRef="#som(...)"
    	   data="{...}"
    	   >

Default MXML Property `content`

Related API Elements

ga.model.IPanelItem
mx.controls.Text

Public Properties

| Property | Defined By
--- | --- | ---
|  | boundData : Object The object in the data model to which this item is bound. | PanelRichText
|  | boundName : String [read-only] The name of the bound object. | PanelRichText
|  | boundText : String The text of the bound object. | PanelRichText
|  | boundValue : Object The value of the bound object. | PanelRichText
|  | caption : String The caption or description of this item. | PanelRichText
|  | captionWidth : Number The value for the width of the Guide Text caption. | PanelRichText
|  | dataRef : String The reference to the data that is bound to the Guide text object in the Guide Design perspective within Workbench. | PanelRichText
|  | helpText : String Additional help text, entered in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0, associated with the Guide text object. | PanelRichText
|  | speak : String The speak text or accessibility text for this item. | PanelRichText

Property Detail

### boundData

property

`boundData:Object`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions: | AIR 1.0, Flash Player 10.2

The object in the data model to which this item is bound. This allows the bound object to be determined using Flex binding instead of using a `dataRef` expression.

Implementation
`public function get boundData():Object`
`public function set boundData(value:Object):void`

### boundName

property

`boundName:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

The name of the bound object.

Implementation
`public function get boundName():String`

### boundText

property

`boundText:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

The text of the bound object.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get boundText():String`
`public function set boundText(value:String):void`

### boundValue

property

`boundValue:Object`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

The value of the bound object.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get boundValue():Object`
`public function set boundValue(value:Object):void`

### caption

property

`caption:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions: | AIR 1.0, Flash Player 10.2

The caption or description of this item. If no caption or description is specified, the caption for this item is bound to the caption of the data model. If the data model does not specify a caption, the default label is used.

Implementation
`public function get caption():String`
`public function set caption(value:String):void`

### captionWidth

property

`captionWidth:Number`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

The value for the width of the Guide Text caption. The default value is the width of the panel that contains the Guide text object.

Implementation
`public function get captionWidth():Number`
`public function set captionWidth(value:Number):void`

### dataRef

property

`dataRef:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

The reference to the data that is bound to the Guide text object in the Guide Design perspective within Workbench.

Implementation
`public function get dataRef():String`
`public function set dataRef(value:String):void`

### helpText

property

`helpText:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions: | AIR 1.0, Flash Player 10.2

Additional help text, entered in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0, associated with the Guide text object.

Implementation
`public function get helpText():String`
`public function set helpText(value:String):void`

### speak

property

`speak:String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions: | AIR 1.0, Flash Player 10.2

The speak text or accessibility text for this item.

Implementation
`public function get speak():String`
`public function set speak(value:String):void`

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00