Packageat.containers
Classpublic class SlideDropTarget
InheritanceSlideDropTarget Inheritance mx.containers.HBox
Implementsmx.binding.IBindingClient

Default MXML PropertydataProvider



Public Properties
 PropertyDefined by
  cursor : IViewCursor
Cursor for the dataProvider.
SlideDropTarget
  dataProvider : Object
[read-only] Sets the data provider for the SlideDropTarget.
SlideDropTarget
  draggingToMoveIndex : int = -1
The index of the currently selected item to be dragged.
SlideDropTarget
  rolledOverIndex : int
Index of the item that is currently under the mouse pointer while dragging onto the component.
SlideDropTarget
Protected Properties
 PropertyDefined by
  current : Array
Holder for the indicies of the currently viewable images.
SlideDropTarget
  duplicates : Array
SlideDropTarget
  scrollBarText : String
The text that is to be displayed on the HScrollBar's FixedScrollThumb.
SlideDropTarget
  st : ScrollThumb
Holder for the HScrollBar's ScrollThumb.
SlideDropTarget
Public Methods
 MethodDefined by
  
addItem(value:Object, buttonClick:Boolean = false):void
Adds an item to the list.
SlideDropTarget
  
Draws the background of the component of a rounded rectangle.
SlideDropTarget
  
drawLine(childIndex:int):void
Draws a line in front of an item at the specified index, to identify a drop point in the component.
SlideDropTarget
  
getIndexUnderPoint(value:Point):int
SlideDropTarget
  
Determines what images are viewable inside of the scrollRect inside this component.
SlideDropTarget
  
moveItem(value:Object):void
SlideDropTarget
  
scrollToEnd(tween:Boolean = false):void
Automatically scrolls to the end of the list.
SlideDropTarget
  
Determines the text that should be displayed on the FixedScrollThumb.
SlideDropTarget
Protected Methods
 MethodDefined by
  
Removes a node based on the node passed through the PreCallModuleEvent.
SlideDropTarget
  
dragCompleteHandler(e:DragEvent):void
Handles the end of the drag and drop operation.
SlideDropTarget
  
dragSlide(e:MouseEvent):void
Handles the dragging of slides in the list.
SlideDropTarget
  
dropMouseDownHandler(e:MouseEvent):void
Handles the dragging and dropping of slides already contained in the component.
SlideDropTarget
  
dropMouseOverHandler(e:MouseEvent):void
Handles the roll over of slides in the list.
SlideDropTarget
  
dropMouseUpHandler(e:MouseEvent):void
Handles the release of the mouse for items already in the list.
SlideDropTarget
  
SlideDropTarget
  
getStartNumber(value:int):int
Helper function to get the number from current with the supplied index.
SlideDropTarget
  
handleRepeatEnd(e:FlexEvent):void
Handles the end of the slideProvider's repeating event.
SlideDropTarget
  
handleScroll(e:ScrollEvent):void
Handles the horizontal ScrollEvent.
SlideDropTarget
  
isMustHave(value:int):Boolean
SlideDropTarget
  
updateCompleteHandler(e:FlexEvent):void
Handles the component's FlexEvent.UPDATE_COMPLETE event.
SlideDropTarget
  
updateList():void
SlideDropTarget
  
Handles updating of the scroll position for the component.
SlideDropTarget
Property detail
currentproperty
protected var current:Array

Holder for the indicies of the currently viewable images.

The default value is [].

cursorproperty 
public var cursor:IViewCursor

Cursor for the dataProvider.

See also

dataProviderproperty 
dataProvider:Object  [read-only]

Sets the data provider for the SlideDropTarget. This is typically a XMLList of slide nodes.

Implementation
    public function get dataProvider():Object
draggingToMoveIndexproperty 
public var draggingToMoveIndex:int = -1

The index of the currently selected item to be dragged.

duplicatesproperty 
protected var duplicates:Array
rolledOverIndexproperty 
rolledOverIndex:int  [read-write]

Index of the item that is currently under the mouse pointer while dragging onto the component.

This property can be used as the source for data binding.

Implementation
    public function get rolledOverIndex():int
    public function set rolledOverIndex(value:int):void
scrollBarTextproperty 
scrollBarText:String  [read-write]

The text that is to be displayed on the HScrollBar's FixedScrollThumb.

The default value is "".

Implementation
    protected function get scrollBarText():String
    protected function set scrollBarText(value:String):void

See also

stproperty 
protected var st:ScrollThumb

Holder for the HScrollBar's ScrollThumb. For the SlideDropTarget, it is a FixedScrollThumb.

See also

Method detail
addItem()method
public function addItem(value:Object, buttonClick:Boolean = false):void

Adds an item to the list.

Parameters
value:Object — The object to add
 
buttonClick:Boolean (default = false) — Boolean to determine if it was added by click or not, and scroll if true
deleteSlide()method 
protected function deleteSlide(e:PreCallModuleEvent):void

Removes a node based on the node passed through the PreCallModuleEvent.

Parameters
e:PreCallModuleEvent — The PreCallModuleEvent
dragCompleteHandler()method 
protected function dragCompleteHandler(e:DragEvent):void

Handles the end of the drag and drop operation.

Parameters
e:DragEvent — The event
dragSlide()method 
protected function dragSlide(e:MouseEvent):void

Handles the dragging of slides in the list.

Parameters
e:MouseEvent
drawBackground()method 
public function drawBackground():void

Draws the background of the component of a rounded rectangle.

drawLine()method 
public function drawLine(childIndex:int):void

Draws a line in front of an item at the specified index, to identify a drop point in the component. If the number is greater than the number of children, then it places a line behind the last child. If the number is 0 or less, then the line is drawn on the left side of the component.

Parameters
childIndex:int — The index of the child in the component to draw a line in front of
dropMouseDownHandler()method 
protected function dropMouseDownHandler(e:MouseEvent):void

Handles the dragging and dropping of slides already contained in the component.

Parameters
e:MouseEvent — The event
dropMouseOverHandler()method 
protected function dropMouseOverHandler(e:MouseEvent):void

Handles the roll over of slides in the list.

Parameters
e:MouseEvent
dropMouseUpHandler()method 
protected function dropMouseUpHandler(e:MouseEvent):void

Handles the release of the mouse for items already in the list.

Parameters
e:MouseEvent — The event
duplicateCheck()method 
protected function duplicateCheck():void
getIndexUnderPoint()method 
public function getIndexUnderPoint(value:Point):intParameters
value:Point

Returns
int
getStartNumber()method 
protected function getStartNumber(value:int):int

Helper function to get the number from current with the supplied index.

Parameters
value:int — The index in current to retrieve

Returns
int — The number at the supplied index
getVisibleChildrenArray()method 
public function getVisibleChildrenArray():Array

Determines what images are viewable inside of the scrollRect inside this component. This will return an Array with two items of the first and last image numbers.

i.e. [4, 9]

Returns
Array — The Array of first and last image numbers
handleRepeatEnd()method 
protected function handleRepeatEnd(e:FlexEvent):void

Handles the end of the slideProvider's repeating event.

Parameters
e:FlexEvent — The Flex event
handleScroll()method 
protected function handleScroll(e:ScrollEvent):void

Handles the horizontal ScrollEvent.

Parameters
e:ScrollEvent — The ScrollEvent
isMustHave()method 
protected function isMustHave(value:int):BooleanParameters
value:int

Returns
Boolean
moveItem()method 
public function moveItem(value:Object):voidParameters
value:Object
scrollToEnd()method 
public function scrollToEnd(tween:Boolean = false):void

Automatically scrolls to the end of the list. Typically done when a new slide is added.

Parameters
tween:Boolean (default = false) — Determines if it should tween to the end, or move there instantly
updateCompleteHandler()method 
protected function updateCompleteHandler(e:FlexEvent):void

Handles the component's FlexEvent.UPDATE_COMPLETE event.

Parameters
e:FlexEvent — The Flex event
updateList()method 
protected function updateList():void
updateScrollPosition()method 
protected function updateScrollPosition():void

Handles updating of the scroll position for the component.

updateScrollThumbText()method 
public function updateScrollThumbText():void

Determines the text that should be displayed on the FixedScrollThumb.