| Package | ga.model |
| Class | public class PanelItem |
| Implements | IPanelItem, IFocusManagerComponent |
A panel item acts as both a place holder in the panel layout and as a run-time component that binds to the form model.
The PanelItem class extends the <mx:PanelItemBase> class
(itself based on the <mx:FormItem> class) so that it will inherit the
appropriate label and alignment capabilities.
Hide MXML Syntax
The properties for PanelItem when acting as a placeholder slot in a panel layout:
Show MXML Syntax
<ga:PanelItem
Properties
repeatItemLimit="-1 to n"
itemInstancesPerCycle="-1 to n"
repeatParent="parentName"
repeatLimit="-1 to n"
parentInstancesPerCycle="-1 to n"
slotIndex="-1 to n"
>
The properties for PanelItem when acting as a the run-time component slotted
into a panel layout. These are in addition to the properties inherited from <mx:FormItem>.
<ga:PanelItem
Properties
caption=""
captionWidth=""
captionAfter=""
toolTip=""
helpText=""
speak=""
dataRef=""
exclusions="[ '', '', '']"
commitEvent="change|valueCommit|click|.."
commitEventProperty="newDate|.."
commitProperty="text|value|selectedItem|.."
commitTarget="rawValue|formattedValue|selectedItem|.."
>
| Property | Defined By | ||
|---|---|---|---|
| boundData : Object
The form object in the model that is bound to this panel item.
| PanelItem | ||
| boundName : String
[read-only]
The text of the bound form object.
| PanelItem | ||
| boundText : String
[-only]
The text of the bound form object.
| PanelItem | ||
| boundValue : Object
[-only]
The value of the bound form object.
| PanelItem | ||
| caption : String
The caption for the field.
| PanelItem | ||
| captionAfter : String
The caption to appear following the field.
| PanelItem | ||
| captionPosition : String = "left"
Indicates the caption position, either to the left or right of the control.
| PanelItem | ||
| captionWidth : Number
The width of the caption for the field.
| PanelItem | ||
| commitEvent : String
[write-only]
The name of the event that is fired when the value is to be committed to the model.
| PanelItem | ||
| commitEventProperty : String
[write-only]
The name of the property in the event object that is committed as the value to the model.
| PanelItem | ||
| commitProperty : String
[write-only]
The name of the property of the UI object that is commited as the value to the model.
| PanelItem | ||
| commitTarget : String
[write-only]
The property name in the model that is updated when the value is committed.
| PanelItem | ||
| dataRef : String
The reference to the data to which the component is bound.
| PanelItem | ||
| editable : Boolean
Specifies whether the UI control is editable.
| PanelItem | ||
| exclusions : Array
An array of property names to ignore when model change event occurs.
| PanelItem | ||
| itemInstancesPerCycle : Number = 0
The number of instances of a panel item that are filled per repeating cycle.
| PanelItem | ||
| parentInstancesPerCycle : Number = 0
The number of instances of the parent container filled per cycle.
| PanelItem | ||
| readOnly : Boolean
The read only attribute for the field.
| PanelItem | ||
| repeatItemLimit : Number = 0
The number of times an item can repeat.
| PanelItem | ||
| repeatParent : String = "null"
The name of the parent to be repeated when Panel Items in the container have been processed.
| PanelItem | ||
| repeatParentLimit : Number = 0
The maximum number of instances that a parent container can repeat.
| PanelItem | ||
| slotIndex : Number = -1
The index of the array of components to be slotted into the panel layout.
| PanelItem | ||
| speak : String
The screen reader or accessibility text for the field.
| PanelItem | ||
| Method | Defined By | ||
|---|---|---|---|
| PanelItem | |||
|
Commits the current UI value to the model.
| PanelItem | ||
|
Returns the fixed caption width.
| PanelItem | ||
|
The created UI control that is the child of this panel item.
| PanelItem | ||
| boundData | property |
boundData:Object [read-write] The form object in the model that is bound to this panel item.
public function get boundData():Object
public function set boundData(value:Object):void
| boundName | property |
boundName:String [read-only] The text of the bound form object.
public function get boundName():String
| boundText | property |
public var boundText:String
The text of the bound form object.
This property can be used as the source for data binding.
| boundValue | property |
public var boundValue:Object
The value of the bound form object.
This property can be used as the source for data binding.
| caption | property |
caption:String [read-write]
The caption for the field.
If not specified, this value binds to the caption specified in the form model. If no caption is
specified in the model, then the default label specified in the LayoutTemplate is used.
public function get caption():String
public function set caption(value:String):void
| captionAfter | property |
captionAfter:String [read-write] The caption to appear following the field.
public function get captionAfter():String
public function set captionAfter(value:String):void
| captionPosition | property |
public var captionPosition:String = "left"
Indicates the caption position, either to the left or right of the control.
| captionWidth | property |
captionWidth:Number [read-write]
The width of the caption for the field.
If specified, the caption uses the <mx:Text> object and wrapping instead of
the default label proccessing.
public function get captionWidth():Number
public function set captionWidth(value:Number):void
| commitEvent | property |
commitEvent:String [write-only]
The name of the event that is fired when the value is to be committed to the model.
The default values are:
change controls derived from <mx:ComboBase> and <mx:ListBase>.change controls derived from <mx:DateField>.valueCommit controls dervived from <mx:RadioButon> and <mx:CheckBox>.valueCommit controls with text property such as <mx:TextInput>.change controls with numeric value property such as <mx:NumericStepper>. public function set commitEvent(value:String):void
| commitEventProperty | property |
commitEventProperty:String [write-only]
The name of the property in the event object that is committed as the value to the model.
If not set, the value of this method defaults to the value of commitProperty.
The default value is:
newDate - Controls derived from <mx:DateField>. public function set commitEventProperty(value:String):void
| commitProperty | property |
commitProperty:String [write-only]
The name of the property of the UI object that is commited as the value to the model. It is
also the property which is updated in the UI object when the commitTarget property
in the model changes.
The default values are:
selectedItems - Controls derived from <mx:ComboBase> and <mx:ListBase>.selectedDate - Controls derived from <mx:DateField>.selected - Controls dervived from <mx:RadioButon> and <mx:CheckBox>.text - Controls with text property such as <mx:TextInput>.value - Controls with numeric value property such as <mx:NumericStepper>. public function set commitProperty(value:String):void
| commitTarget | property |
commitTarget:String [write-only]
The property name in the model that is updated when the value is committed.
The default values are:
rawValue - Controls derived from <mx:ComboBase> and <mx:ListBase>.dateValue - Controls derived from <mx:DateField>.booleanValue - Controls dervived from <mx:RadioButon> and <mx:CheckBox>.formattedValue - Controls with text property such as <mx:TextInput>.numericValue - Controls with numeric value property such as <mx:NumericStepper>. public function set commitTarget(value:String):void
| dataRef | property |
dataRef:String [read-write] The reference to the data to which the component is bound.
public function get dataRef():String
public function set dataRef(value:String):void
| editable | property |
editable:Boolean [read-write] Specifies whether the UI control is editable.
public function get editable():Boolean
public function set editable(value:Boolean):void
| exclusions | property |
exclusions:Array [read-write]
An array of property names to ignore when model change event occurs. The possible values are:
presenceaccessrawValueitemsCollectioncaptionhelpTexttoolTipspeak public function get exclusions():Array
public function set exclusions(value:Array):void
| itemInstancesPerCycle | property |
public var itemInstancesPerCycle:Number = 0
The number of instances of a panel item that are filled per repeating cycle. The possible values are:
1 - (default) After filling the panel layout with the specified number of panel item instances,
the form guide processing searches for the next PanelItem.-1 - The item repeats indefinitely until the repeatItemLimit value is reached.>0 - The item is repeated the specified number of times or until the repeatItemLimit value is reached.| parentInstancesPerCycle | property |
public var parentInstancesPerCycle:Number = 0
The number of instances of the parent container filled per cycle. The possible values are:
1 - (default) One instance of the parent will be filled per cycle.-1 - The parent repeats indefinitely until the repeatParentLimit is reached.>0 - The parent is repeated the specified number of times, or until the repeatParentLimit is reached.| readOnly | property |
readOnly:Boolean [read-write] The read only attribute for the field.
public function get readOnly():Boolean
public function set readOnly(value:Boolean):void
| repeatItemLimit | property |
public var repeatItemLimit:Number = 0
The number of times an item can repeat. The possible values are:
0 - (default) Item can not repeat.-1 - This item can have an unlimited number of occurrences.>0 - This item repeats until the number of instances matches the limit specified.| repeatParent | property |
public var repeatParent:String = "null"
The name of the parent to be repeated when Panel Items in the container have been processed. The default value is the parent container of the current item.
| repeatParentLimit | property |
public var repeatParentLimit:Number = 0
The maximum number of instances that a parent container can repeat. The possible values are:
0 - (default) The parent is not repeated.-1 - The parent can be repeated any number of times.>0 - The parent can be repeated the specified number of times.| slotIndex | property |
public var slotIndex:Number = -1
The index of the array of components to be slotted into the panel layout.
The index value is zero-based and is relative to the index value of the starting component of the current cycle.
| speak | property |
speak:String [read-write] The screen reader or accessibility text for the field.
public function get speak():String
public function set speak(value:String):void
| PanelItem | () | Constructor |
public function PanelItem()
| commitValue | () | method |
public function commitValue():void
Commits the current UI value to the model.
| getCaptionWidth | () | method |
public function getCaptionWidth():Number
Returns the fixed caption width. This is useful in situations where you are using grid headings.
Note: This method does not return the calculated width.
ReturnsNumber |
| getCreatedItemComponent | () | method |
public function getCreatedItemComponent():IFlexDisplayObject
The created UI control that is the child of this panel item.
ReturnsIFlexDisplayObject |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/ga/model/PanelItem.html