Detecting an item click event on a Spark List control in Flex 4
The following example shows how you can dispatch an itemClick event on a Spark List control in Flex 4 by creating a custom item renderer which listens for the click event and redispatches an itemClick event object.
The following example(s) require Flash Player 10 and the Adobe Flex 4 SDK. To download the Adobe Flash Builder 4 trial, see http://www.adobe.com/products/flex/. To download the latest nightly build of the Flex 4 SDK, see http://opensource.adobe.com/wiki/display/flexsdk/Download+Flex+4.
For more information on getting started with Flex 4 and Flash Builder 4, see the official Adobe Flex Team blog.
<?xml version="1.0" encoding="utf-8"?> <!-- http://blog.flexexamples.com/2010/05/14/detecting-an-item-click-event-on-a-spark-list-control-in-flex-4/ --> <s:Application name="Spark_List_itemClick_test" xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <s:layout> <s:HorizontalLayout horizontalAlign="center" verticalAlign="middle" /> </s:layout> <fx:Script> <![CDATA[ import mx.events.ItemClickEvent; import spark.events.IndexChangeEvent; protected function init():void { lst.addEventListener(ItemClickEvent.ITEM_CLICK, lst_itemClickHandler); } protected function lst_itemClickHandler(evt:ItemClickEvent):void { addAndAutoScroll(evt); } protected function lst_changeHandler(evt:IndexChangeEvent):void { addAndAutoScroll(evt); } protected function addAndAutoScroll(obj:Event):void { arrList.addItem({time:now(), type:obj.type, item:obj.currentTarget.selectedItem}); grid.validateNow(); grid.verticalScrollPosition = grid.maxVerticalScrollPosition; } protected function now():String { return new Date().toTimeString(); } ]]> </fx:Script> <s:List id="lst" itemRenderer="skins.CustomItemClickItemRenderer" horizontalCenter="0" verticalCenter="0" initialize="init();" change="lst_changeHandler(event)"> <s:layout> <s:VerticalLayout gap="0" horizontalAlign="contentJustify" requestedRowCount="8" /> </s:layout> <s:dataProvider> <s:ArrayList source="[One,Two,Three,Four,Five,Six,Seven,Eight,Nine]" /> </s:dataProvider> </s:List> <mx:DataGrid id="grid" verticalScrollPolicy="on"> <mx:columns> <mx:DataGridColumn dataField="time" width="150" /> <mx:DataGridColumn dataField="type" /> <mx:DataGridColumn dataField="item" /> </mx:columns> <mx:dataProvider> <mx:ArrayList id="arrList" /> </mx:dataProvider> </mx:DataGrid> </s:Application>
And the custom Spark item renderer, skins/CustomItemClickItemRenderer.mxml, is as follows:
<?xml version="1.0" encoding="utf-8"?> <!-- http://blog.flexexamples.com/2010/05/14/detecting-an-item-click-event-on-a-spark-list-control-in-flex-4/ --> <s:ItemRenderer name="CustomItemClickItemRenderer" xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" autoDrawBackground="true" click="itemrenderer1_clickHandler(event);"> <fx:Script> <![CDATA[ import mx.events.ItemClickEvent; protected function itemrenderer1_clickHandler(evt:MouseEvent):void { var e:ItemClickEvent = new ItemClickEvent(ItemClickEvent.ITEM_CLICK, true); e.item = data; e.index = itemIndex; dispatchEvent(e); } ]]> </fx:Script> <s:Label id="labelDisplay" left="3" right="3" top="5" bottom="5" /> </s:ItemRenderer>
This entry is based on a beta version of the Flex 4 SDK and therefore is very likely to change as development of the Flex SDK continues. The API can (and will) change causing examples to possibly not compile in newer versions of the Flex 4 SDK.
Peter deHaan
Peter deHaan currently works for Adobe on the Flex SDK QA team. While not working on Flex, Flash, and ColdFusion applications, Peter enjoys making up bios and writing in 3rd person. Peter's rarely updated blog can be found at blogs.adobe.com/pdehaan/, actionscriptexamples.com, airexamples.com, and coldfusionexamples.com.
-
Add Widgets (Content Sidebar)
This is your Content Sidebar. Edit this content that appears here in the widgets panel by adding or removing widgets in the Content Sidebar area.
11 Responses to Detecting an item click event on a Spark List control in Flex 4
-
Categories
- Accordion
- AccordionHeader
- ActionScript
- AddChild
- AdvancedDataGrid
- Alert
- alpha
- Animate
- AnimateProperties
- Application
- Application (Spark)
- ArrayCollection
- BarChart
- baseColor
- beta
- beta1
- beta2
- Bitmap
- Bitmap/BitmapData
- BitmapData
- BitmapFill
- BitmapFill (Spark)
- BitmapGraphic
- BitmapImage
- BitmapImage (Spark)
- BitmapImageResizeMode
- Border (Spark)
- BorderContainer (Spark)
- Box
- BuildInfo
- Button
- Button (Spark)
- ButtonBar
- ButtonBar (Spark)
- ByteArray
- Camera
- Charting
- CheckBox
- CheckBox (Spark)
- ClassFactory
- CollectionEvent
- Color
- ColorPicker
- ColorUtil
- ComboBox
- ComboBoxArrowSkin
- Compiler
- Component
- Component (Spark)
- Configuration
- Container
- ContextMenu
- ContextMenuEvent
- ContextMenuItem
- CSSCondition
- CSSSelector
- CSSStyleDeclaration
- CurrencyFormatter
- CursorManager
- Data Binding
- DataGrid
- DataGrid (Spark)
- DataGridColumn
- Date
- DateBase
- DateChooser
- DateField
- DateFormatter
- Debugging
- DefaultComplexItemRenderer
- DefaultTileListEffect
- DropDownList
- DropDownList (Spark)
- DropDownListButtonSkin
- DropDownListSkin
- DropShadowFilter
- E4X
- Effects
- Ellipse
- EmailValidator
- Embed
- Event
- Fade
- FileFilter
- FileReference
- fill
- Filters
- Flash
- Flash Integration
- FlashVars
- Flex 3 SDK
- Flex Builder
- Flex Builder 3
- Flex SDK
- Flex4
- FLVPlayback
- FocusManager
- FontLookup
- Fonts
- Form
- Form (Spark)
- FormHeading (Spark)
- FormItem
- FormItem (Spark)
- Forms
- FTETextField (Spark)
- FullScreen
- FullScreenEvent
- FxAnimateColor
- FxButtonBar
- FxCheckBox
- FXG
- FxHScrollBar
- FxHSlider
- FxList
- FxNumericStepper
- FxRadioButton
- FxRotate3D
- FxScroller
- FxTextArea
- FxTextInput
- FxToggleButton
- FxVScrollBar
- FxVSlider
- getStyleDeclaration()
- GradientEntry
- Graphic (Spark)
- HBox
- HDividedBox
- HGroup (Spark)
- HorizontalLayout
- HorizontalList
- HSBColor (Spark)
- HScrollBar (Spark)
- HSlider
- HSlider (Spark)
- HTML template
- ID3Info
- Image
- Image (Spark)
- ImageSnapshot
- itemRenderer
- JointStyle
- Label
- Label (Spark)
- Legend
- LegendItem
- LigatureLevel
- Line
- LinearGradientStroke
- LineScaleMode
- LinkBar
- LinkButton
- List
- List (Spark)
- Menu
- MenuBar
- Metadata
- MetadataEvent
- Model
- Mouse
- MouseCursor
- MouseEvent
- Move
- Namespace
- NavigatorContent (Spark)
- needsSWF
- NetConnection
- NetStream
- Nightly Builds
- NumberBaseRoundType
- NumberFormatter
- NumberValidator
- NumericCompare
- NumericStepper
- NumericStepper (Spark)
- ObjectProxy
- ObjectUtil
- paddingLeft
- paddingRight
- Panel
- Panel (Spark)
- Parallel
- Path
- PieChart
- PieSeries
- PieSeriesItem
- PopUpAnchor (Spark)
- PopUpButton
- PopUpManager
- ProgrammaticSkin
- ProgressBar
- PropertyChangeEvent
- QName
- RadialGradient
- RadioButton
- RadioButton (Spark)
- RadioButtonGroup
- RadioButtonGroup (Spark)
- Rect
- RegExp
- Regular Expressions
- Repeater
- RichEditableText
- RichText
- RichText (Spark)
- RichTextEditor
- Rotate
- Rotate3D (Spark)
- Scroller (Spark)
- Sequence
- setStyle()
- SimpleText
- SimpleText (Spark)
- skinClass
- Slider
- SliderEvent
- SolidColor
- SolidColorStroke
- Sort
- SortField
- Sound
- SoundEffect
- Spinner (Spark)
- SpriteVisualElement (Spark)
- StageDisplayState
- States
- StringUtil
- StringValidator
- StyleManager
- Styles
- SWFLoader
- SWFObject
- System
- SystemManager
- TabBar
- TabBar (Spark)
- TabNavigator
- TabStopFormat
- Text
- Text Layout Framework (TLF)
- TextArea
- TextArea (Spark)
- TextBox
- TextConverter
- TextEvent
- TextFlow
- TextFlowUtil
- TextFormat
- TextGraphic
- TextInput
- TextInput (Spark)
- TextLayoutFormat
- TextView
- Themes
- TileLayout
- TileList
- TileOrientation
- Timer
- TitleWindow
- TitleWindow (Spark)
- TLF
- ToggleButton (Spark)
- ToggleButtonBar
- ToolTip
- Transition
- Tree
- TruncationOptions
- UIComponent
- UIFTETextField
- Updater
- URLLoader
- URLRequest
- URLUtil
- URLVariables
- ValidationResultEvent
- Validator
- Validators
- VBox
- VDividedBox
- Vector
- VerticalLayout
- VerticalLayout (Spark)
- VGroup (Spark)
- Video
- VideoDisplay
- VideoElement
- VideoElement (Spark)
- VideoEvent
- VideoPlayer (Spark)
- VideoPlayerScrubBar
- ViewStack
- VScrollBar (Spark)
- VSlider
- VSlider (Spark)
- XML
- XMLList
- XMLListCollection
- ZipCodeValidator
- ZipCodeValidatorDomainType
- Zoom
-
Articles
- December 2010
- November 2010
- October 2010
- September 2010
- August 2010
- July 2010
- June 2010
- May 2010
- April 2010
- March 2010
- February 2010
- January 2010
- December 2009
- November 2009
- October 2009
- September 2009
- August 2009
- July 2009
- June 2009
- May 2009
- April 2009
- March 2009
- February 2009
- January 2009
- December 2008
- November 2008
- October 2008
- September 2008
- August 2008
- July 2008
- June 2008
- May 2008
- April 2008
- March 2008
- February 2008
- January 2008
- December 2007
- November 2007
- October 2007
- September 2007
- August 2007
- July 2007
-
Meta


Hi Peter, do you know the reasons for the removal of the itemClickEvent in spark list?
It seems that it was one of the most used event in the halo list, and it’s kind of a drag to have to create a custom event/itemRenderer every time we need it for a spark list…
Is is for performance reason?
Do you know if the is a bug/feature request in the JIRA about this?
thanks.
@Dimitri Kara,
http://bugs.adobe.com/jira/browse/SDK-24859
Feel free to add comments to the JIRA bug.
Peter
I think maybe part of the reason for that is seperating logic from UI.
Kind of a drag, really, but thanks for explaining how to do it.
I am trying to compile this example using command line compilation, and I get the following error:
Error: Definition skins:CustomItemClickItemRenderer could not be found.
The file ./skins/CustomItemClickItemRenderer.mxml is present, but I don’t understand how the compiler is suppose to link the two??
Perfecft, thanks!
thanks, it’s great, but not example?
Nice one, thanks.
Really superb…..I have been searching this….
Great tip! It helped me a great deal!
The only thing I would add is to pay close attention to the ‘true’ value for the ‘bubbles’ parameter on the ‘dispatchEvent’ call. That’s the part that actually makes the event dispatch on the List work. (It threw me through a loop at first)
Hi!
im implementing your code for an App, and it works fine, but i get a bug that i cant remove.
i need only to dispatch the event when i click on an item.
When i click on the List scroller the event is also dispached and…error appear.
How can i fix it?
thanx!!