mako 0.0.0

data/lib/mako/data/flash_widget_dev_core/src/nm/ui/List_Base.as

@@ -0,0 +1,644 @@
+/* See the file "LICENSE.txt" for the full license governing this code. */
+package nm.ui
+{
+import flash.display.MovieClip;
+import flash.display.Sprite;
+import flash.events.Event;
+import flash.events.MouseEvent;
+import flash.text.TextField;
+import flash.text.TextFormat;
+import flash.utils.*;
+import nm.util.BitField;
+import org.rubyamf.remoting.ssr.ResultEvent;
+public class List_Base extends Component
+{
+	//--------------------------------------------------------------------------
+	//
+	//  Variables
+	//
+	//--------------------------------------------------------------------------
+	/**
+	 *  Determines if more than one item can be selected
+	 */
+	protected var _multiSelect:Boolean = false;
+	/**
+	 *  Determines if text field can be edited
+	 */
+	protected var _editable:Boolean = false;
+	/**
+	 *  The scroll position of the list
+	 */
+	protected var _scrollPos:int = 0;
+	/**
+	 *  Array of textfields that compose the list
+	 */
+	protected var _textFields:Array;
+	/**
+	 *  Array of elements that compose the list
+	 */
+	protected var _listItems:Array;
+	/**
+	 *  A graphic background
+	 */
+	protected var _bg:Sprite;
+	/**
+	 *  Container for teh textfields
+	 */
+	protected var _textFieldHolder:Sprite;
+	/**
+	 *  Index of the item that was last clicked
+	 */
+	protected var _lastClicked:int;
+	/**
+	 *  bitField that handles the selected items
+	 */
+	protected var _selected:BitField;
+	protected var _mouseAction:Boolean = false;
+	protected var _watchLabels:Boolean = false;
+	/**
+	 *  number of rows to show on the screen
+	 */
+	protected var _numShown:int;
+	/**
+	 *  scrollbar needed for scrolling
+	 */
+	protected var _sbar:ScrollBar;
+	/**
+	 *  item that is currently in hover state
+	 */
+	protected var _hover:int;
+	/**
+	 *  interval for updating values linked to an external array
+	 */
+	protected var _updateInterval:Number;
+	//--------------------------------------------------------------------------
+	//
+	//  Constructor
+	//
+	//--------------------------------------------------------------------------
+	public function List_Base(width:Number, height:Number, multiSelect:Boolean = false)
+	{
+		super(false, width, height);
+		_multiSelect = multiSelect;
+		_textFields = new Array();
+		//_tfs.setArrangeStyle("relative", "items", 1);
+		_selected = new BitField();
+		_listItems = new Array();
+		_scrollPos = 0;
+		//tabChildren = false // dont allow flash tab control to select the textfields or scrollbar
+		_editable = false;
+		//Create main visual components
+		_bg = new MovieClip();
+		_textFieldHolder = new MovieClip();
+	}
+	//--------------------------------------------------------------------------
+	//
+	//  Functions
+	//
+	//--------------------------------------------------------------------------
+	//----------------------------------
+	//  Drawing
+	//----------------------------------
+	public override function draw():void
+	{
+		super.draw();
+		//Add Main Visual Components
+		addChild(_bg);
+		addChild(_textFieldHolder);
+		//_enabled = true;
+		_textFieldHolder.addEventListener(MouseEvent.MOUSE_MOVE, listMouseMove, false, 0, true);
+		_textFieldHolder.addEventListener(MouseEvent.ROLL_OVER, listOver, false, 0, true);
+		_textFieldHolder.addEventListener(MouseEvent.ROLL_OUT, listOut, false, 0, true);
+		_textFieldHolder.addEventListener(MouseEvent.MOUSE_UP, listRelease, false, 0, true);
+		_textFieldHolder.addEventListener(MouseEvent.MOUSE_WHEEL, onMouseWheel, false, 0, true);
+		//TODO: Need an event for doubleclick to link to 'listDoubleClick'
+		if(stage && _sbar) addChild(_sbar);
+		redraw();
+	}
+	/**
+	* Explict call to update the content of the list cells, use this if your setting values via dataProvider and watchLabels isnt updating the content.
+	* This call does not redraw the component, meerely update the contents
+	*/
+	public override function redraw():void
+	{
+		super.redraw();
+		//////trace("__________STAGE: " + stage + "     " + _sbar.stage);
+		_numShown = Math.floor((height - 2*getStyle("borderWidth"))/getStyle("itemHeight")) // update numshown when we redraw
+		//////trace("Num Shown: " + getStyle("borderWidth"));
+		//if(_sbar) _sbar.linesPerPage = _numShown;
+		onScrollBarMove()
+		//_tfs_mc._x = _tfs_mc._y = getStyle("borderWidth") // move the textfields inside the border
+		refresh()
+		drawBg();
+	}
+	/**
+	* Explict call to update the content of the list cells, use this if your setting values via dataProvider and watchLabels isnt updating the content.
+	* This call does not redraw the component, meerely update the contents
+	*/
+	public function refresh():void
+	{
+		updateTextFieldCount()
+		updateTextFields()
+		checkForScroll()
+	}
+	/**
+	* Draws the background of the list, this method is ment to be extended
+	*/
+	protected function drawBg():void {}
+	/**
+	* Colorize the cell in its selected state, this method is ment to be extended
+	* @param	index	Number index of the cell to colorize
+	*/
+	protected function colorCellSelected(index:Number):void {}
+	/**
+	* Colorize the cell in its highlighted state, this method is ment to be extended
+	* @param	index	Number index of the cell to colorize
+	*/
+	protected function colorCellHighlight(index:Number):void {}
+	/**
+	* Colorize the cell in its rest state, this method is meant to be extended
+	* @param	index	Number index of the cell to colorize
+	*/
+	protected function colorCellRest(index:Number):void {}
+	//--------------------------------------------------------------------------
+	//
+	//  MOUSE INTERACTION
+	//
+	//--------------------------------------------------------------------------
+	//listDoubleClick
+	//destroyEditBox
+	//checkForEditMouseOut
+	/**
+	 * When mouse moves, this function is called
+	 * @param	e
+	 */
+	private function onMouseMove(e:Event):void {}
+	private function onMouseWheel(e:MouseEvent):void
+	{
+		if(e.delta > 0)
+		{
+			scrollUp();
+		}
+		else if(e.delta < 0)
+		{
+			scrollDown();
+		}
+	}
+	/**
+	* When mouse enters the list, called from Delegate for tfs_mc.
+	* Turn on mouse move listener and scroll wheel
+	*/
+	private function listOver(e:Event):void
+	{
+		//updateTextFields() // update the data displayed
+		_mouseAction = true
+		listMouseMove(e)
+		if(_sbar != null) _sbar.wheelEnabled = true;
+	}
+	/**
+	* When mouse leaves the list, called from Delegate for tfs_mc.
+	* Turn of mouse move listener, turn off wheel scrolling
+	*/
+	private function listOut(e:Event):void
+	{
+		_mouseAction = false; // turn off mouse interaction
+		if(_sbar != null) _sbar.wheelEnabled = false;
+		var element:int = _hover + _scrollPos;
+		if(_selected.isSet(element)) colorCellSelected(_hover)
+		else colorCellRest(_hover)
+		_hover = undefined;
+	}
+	/**
+	* When mouse up on the list, called from Delegate for tfs_mc.
+	* determine select/unselect with attention to shift and control keys
+	*/
+	private function listRelease(e:Event):void
+	{
+		//focused = true
+		var element:Number = _hover + _scrollPos
+		// if multi select allowed and user is holding control	(Key.isDown does not work in AS3)
+		//if(Key.isDown(Key.CONTROL) && multiSelect) {
+			//if(selected.isSet(element)) deSelectItem(element);
+			//else selectItem(element);
+		//}
+		// if user is holding shift (Key.isDown does not work in AS3)
+		//else if(Key.isDown(Key.SHIFT) && _multiSelect) {
+			//if(elements[_lastClicked] != undefined) {
+				//var range = element - _lastClicked;
+				//if(element > _lastClicked) selectItem(_lastClicked + 1, Math.abs(element - _lastClicked));
+				//else selectItem(element, Math.abs(element - _lastClicked));
+			//}
+			//else selectItem(element);
+		//}
+		//else{
+			//deSelectAll()
+			selectItem(element);
+		//}
+		_lastClicked = element;
+		dispatchEvent(new ResultEvent("select", false, false, element));
+	}
+	/**
+	* When mouse moves while its over the list, assigned to this.onMouseMove by this.listOver.
+	* figure out which item the cursor is over and highlight it
+	*/
+	private function listMouseMove(e:Event):void
+	{
+		var itemHeight:Number = getStyle("itemHeight");
+		var adjustedMouseY:Number = mouseY - getStyle('borderWidth');
+		// figure out which item mouse is currently over
+		var curHover:int = (adjustedMouseY - (adjustedMouseY % itemHeight)) / itemHeight;
+		//////trace("Hovering: " + curHover, _hover);
+		// if we arent over the same item as before update the last cell's colors
+		if(curHover != _hover || (curHover == 0 && !_textFields[_hover].background))
+		{
+			//////trace("  Adjusting Hover Selection (" + curHover + ")");
+			//if(adjustedMouseY == _textFieldHolder.height) curHover -- // fixes problem with last item not selecting
+			var element:Number = _hover + _scrollPos
+			if(_selected.isSet(element)) colorCellSelected(_hover);
+			else colorCellRest(_hover);
+			_hover = curHover;
+			colorCellHighlight(_hover); // highlight the current cell
+			dispatchEvent(new ResultEvent("rollOver", false, false, _hover));
+		}
+	}
+	//******************* SCROLLING ***********************//
+	/**
+	* check for the need of a scroll bar, update the scrollbar and add/remove the scroll bar if it is needed or not
+	*/
+	private function checkForScroll():void
+	{
+		if(_listItems.length > _numShown)
+		{
+			if(_sbar == null)
+			{
+				_sbar = new ScrollBar();
+				addChild(_sbar);
+				//_sbar.draw();
+				//_sbar.focusable = false;
+				//////trace("NUM SHOWN: " + _numShown);
+				_sbar.linesPerPage = _numShown;
+				_sbar.addEventListener(ScrollBar_base.SCROLL, onScrollBarMove, false, 0, true);
+				_sbar.wheelEnabled = _mouseAction;
+			}
+			if(_sbar != null)
+			{
+				// if the scrollbar location isnt correct, update it and resize all the textfields
+				var bW:Number = getStyle("borderWidth");
+				var sB:Number = _sbar.getStyle("borderWidth");
+				if(_sbar.y != bW - sB) _sbar.y = bW - sB;
+				if(_sbar.x != width - _sbar.width - bW + sB) _sbar.x = width -  _sbar.width - bW + sB;
+				_sbar.totalLines = _listItems.length;		//update the length of the scrollbar
+				_sbar.scrollByLines = 1;
+			}
+		}
+		else if(_sbar != null)
+		{
+			removeChild(_sbar);
+			//_sbar.removeAllEventListeners();
+			_sbar = null;
+		}
+		resizeFields();
+	}
+	/**
+	* set the position of the current scroll, also fired by the scroll bar listener
+	*/
+	private function onScrollBarMove(...args):void
+	{
+		if(_sbar)
+		{
+			var oldpos:Number = _scrollPos
+			////trace(_scrollPos)
+			// if theres no scroll, set pos to 0
+			_scrollPos = (_sbar.scroll? Math.round((_listItems.length - _numShown) * _sbar.scroll / 100) : 0);
+			////trace((_sbar.scroll), Math.round((_listItems.length - _numShown) * _sbar.scroll / 100), oldpos)
+			if(_scrollPos != oldpos)
+			{
+				//destroyEditBox();
+				updateTextFields();
+			}
+				//updateTfs();
+		}
+	}
+	/**
+	* scroll up one position
+	*/
+	private function scrollUp():void
+	{
+		var pos:int = --_scrollPos >= 0 ? _scrollPos : 0
+		//_sbar.scroll = (_scrollPos * 100) / (_listItems.length - _numShown*2 + scroll + 1);
+		_sbar.scroll = (_scrollPos * 100) / (_listItems.length - _numShown);
+		updateTextFields();
+	}
+	/**
+	* scroll down one position
+	*/
+	private function scrollDown():void
+	{
+		var pos:Number = _scrollPos < _listItems.length - _numShown ? (_scrollPos+1) : _listItems.length - _numShown
+		_sbar.scroll = (pos * 100) / (_listItems.length - _numShown);
+		updateTextFields();
+	}
+	/**
+	* scroll to a specified position
+	* @param	index	Number position to move the scroll bar to
+	*/
+	public function scrollTo(index:Number):void
+	{
+		_sbar.scroll = Math.floor((index * 100) / (_listItems.length - _numShown));
+	}
+	//************************** PUBLIC METHODS ********************//
+	/**
+	* Set an item as selected (highlight and add to the selectedIndicies list).  Optionaly set a length of items as selected using the second length argument.
+	* selectItem will operate according the myList.multiSelect, if multiSelect=true, selectItem will add to the list of items selected, if multiSelect = false,
+	* selectItem will unselect previous selections, selected only the new item.   In the later case, if a run is given, only the last item in the run will be selected.
+	* @usage	to select a single item: myList.selectItem(3);  to select a run of items starting at index 3 to index 10: myList.selectItem(3, 8);
+	* @param	index	Number of the index to be selected
+	* @param	length	Number of the length of items to be selected, starting and index
+	*/
+	public function selectItem(index:Number, length:Number = NaN):void
+	{
+		//////trace('selecting ' + index)
+		// make sure the index is in range
+		if(index >= 0 && index < _listItems.length)
+		{
+			// if multiselect is false, remove all previous selections and only select the last item given
+			if(_multiSelect == false)
+			{
+				deSelectAll();
+				if(!isNaN(length)) index = index+length-1;
+				length = undefined
+			}
+			_selected.set(index, true, length);
+			if(length > 1) updateTextFields(); // update the whole dispaly
+			else updateTF(index-_scrollPos); // only update this one
+		}
+	}
+	/**
+	* Relocate an item from one index to another.  The item to be moved will be removed from the list, then placed at the to index.  If from < to, the item at to index will appear above the moved item,
+	* if from > to, the moved item will appear above the item previously at the to location.
+	* @param	from	Number index of the item you wish to move
+	* @param	to	Number index of the location you wish the item to be moved to
+	*/
+	public function moveItem(from:Number, to:Number):void
+	{
+		//Move selection:
+		var sel:Boolean = _selected.isSet(from);
+		//Move element:
+		var temp:ListItem = removeItem(from);
+		addItem(temp.label, temp.data, to);
+	}
+	/**
+	* Remove an item at a given index
+	* @param	index	Number index of the element to remove
+	* @param	skipUpdate	Boolean Optional (default false) to skip updating the screen
+	* @return
+	*/
+	public function removeItem(index:Number, skipUpdate:Boolean = false):ListItem
+	{
+		if(isNaN(index)) index = _listItems.length - 1;
+		if(_selected.isSet(index)) deSelectItem(index);
+		_selected.cut(index); // remove it's entry from the bitfield
+		if(_lastClicked == index) _lastClicked = undefined;
+		else if(_lastClicked > index) _lastClicked--;
+		var temp:ListItem = _listItems.splice(index, 1)[0];
+		if(_listItems.length < _numShown)
+		{
+			var tf:TextField = _textFields.splice(_listItems.length, 1)[0];
+			if(tf.parent) tf.parent.removeChild(tf);
+			drawBg();
+		}
+		if(skipUpdate != true)
+		{
+			onScrollBarMove();
+			if(_scrollPos < 1) updateTextFields(index-_scrollPos-1); // only do this in the case that the
+			checkForScroll();
+		}
+		return temp;
+	}
+	/**
+	* Remove all items and empty the list
+	*/
+	public function clear():void
+	{
+		if(_listItems.length > 0)
+		{
+			for(var i:String in _textFields) _textFields[i].removeTextField();
+			_textFields = new Array();
+			//_tfs = new ArrangeArray();
+			//_tfs.setArrangeStyle("relative", "items", 1);
+			//unWatchItems();
+			_listItems = new Array();
+			deSelectAll();
+			checkForScroll()
+			_scrollPos = 0;
+			dispatchEvent(new Event("change"));
+		}
+	}
+	/**
+	* unselect an item (un-highlight and remove from selectedIndicies list).  Optionally deselect a length of items using the second length argument.
+	* @usage	to unselect a single item: myList.unSelectItem(3); to unselect a run of items starting at index 3 to index 5: myList.unSelectItem(3, 3);
+	* @param	indexSet	Number of the index to be unselected
+	* @param	length	Number of the length of items to be selected, starting at index
+	*/
+	public function deSelectItem(index:Number, length:Number = 0):void
+	{
+		if(index >= 0 && index < _listItems.length){
+			if(length > 0) _selected.set(index, false, length)
+			else _selected.set(index, false);
+		}
+	}
+	/**
+	* unselect all of the items
+	*/
+	public function deSelectAll():void
+	{
+		_selected.clearAll();
+		for(var i:int = 0; i < _textFields.length; i++)
+		{
+			colorCellRest(i)
+		}
+	}
+	/**
+	* add an item to the list.
+	* @param	label	String to display in the list cell
+	* @param	data	Value of item.data for this cell
+	* @param	index	Number, Optional (default elements.length), indicating the location to insert the new item at
+	*/
+	public function addItem(label:String, data:* = null, index:Number = -1):void
+	{
+		var newElement:ListItem = new ListItem(label, data);
+		if(index < 0 || index > _listItems.length) index = _listItems.length;
+		if(index == _listItems.length) _listItems.push(newElement)	//this is much faster than splice
+		else _listItems.splice(index, 0, newElement);				//insert the item into elements
+		//_selected.insert(index, false);								//this makes sure any items after this one stay selected
+		if(_lastClicked > index) _lastClicked++						//if last clicked is below this item, increment it to it points at the same item
+		//if(_pos > index) scrollUp();									//scroll up if we are below the new item
+		if(index < _scrollPos + _numShown) updateTextFields(index);				//if the item is on screen or above, do this before updateTFC count to skip redundant tf updates
+		//watchItems(index);											//notify watch items
+		updateTextFieldCount();											//may need to update the tf count
+		if(_sbar != null) checkForScroll();											//may also need to show the scroll bar
+	}
+	/**
+	* Update an item's label, data, and selected status
+	* @param	index	Number index of the item to update
+	* @param	label	String value for the list cell display
+	* @param	data	Value of the data
+	*/
+	public function updateItem(index:Number, label:String, data:*):void
+	{
+		_listItems[index] = new ListItem(label, data);
+		if(index >= _scrollPos && index < _scrollPos+_numShown) updateTF(index);		// if the updated item is onscreen, update its textfield
+	}
+	/**
+	* return the element at a given index
+	* @param	index	Number of the index to get
+	* @return	Object with object.label and object.data
+	*/
+	public function getItem(index:Number):Object
+	{
+		return _listItems[index];
+	}
+	/**
+	* Set the elements of the list to a precompiled set of values.  The passed array is duplicated in an attempt to seperate the data from the passed values.
+	* @param	values	Array of objects with label and data members (or an array of strings/numbers to be used as a label)
+	*/
+	public function setValues(values:Array):void
+	{
+		clear(); // clear existing stuff
+		_listItems = new Array();
+		for(var i:* in values)
+		{
+			// duplicate the passed in array to seperate reference ties to the passed in array
+			_listItems[i] = (values[i] is Object ? new ListItem(values[i].label, values[i].data) : new ListItem(values[i].label))
+		}
+		_watchLabels = false // dont watch the labels because they are internally controlled by us
+		updateTextFieldCount(); // update the field count to the new data
+		checkForScroll(); // check for scroll bar necisity with new data
+		dispatchEvent(new Event("change"));
+	}
+	//**************************** DISPLAY **********************//
+	//watchItems
+	//unWatchItems
+	//valueUpdate
+	//onFocusOut
+	//onFocusKeyDown
+	//isVisible
+	private function resizeFields():void
+	{
+		var tfWidth:Number = width - 2 * getStyle("borderWidth");
+		// TODO: this works, but doesnt seem necissary as the bar is on top of them anyway
+		if(_sbar != null)
+		{
+			tfWidth -= _sbar.width // compensate for the scrollbar if it exists
+		}
+		// if the widths arent the correct size, resize them all
+		if(_textFields.length && _textFields[0].width != tfWidth)
+		{
+			for(var i:String in _textFields)
+			{
+				_textFields[i].width = tfWidth;
+			}
+		}
+	}
+	/**
+	* Update the data and selected status of the textfields on stage
+	* @param	start	Number optional (default 0) start index of the element to begin updating at and run untill the total
+	*/
+	private function updateTextFields(start:Number = 0):void
+	{
+		if(!isNaN(_updateInterval)) {
+			clearInterval(_updateInterval);
+			_updateInterval = undefined;
+		}
+		for(;start <= _numShown; start++) updateTF(start)
+	}
+	/**
+	* Update a single TextField's value and color
+	* @param	i	Number index of the textfield to update
+	*/
+	private function updateTF(i:Number):void
+	{
+		if(_textFields[i]) {
+			_textFields[i].text = _listItems[i + _scrollPos].label;
+			if(_selected.isSet(i + _scrollPos)) colorCellSelected(i);
+			else colorCellRest(i);
+		}
+	}
+	/**
+	* Create a new textfield(s)
+	* @param	count	Number of textfields to add
+	*/
+	private function createTF(count:int = 1):void
+	{
+		var numItems:int = _listItems.length;
+		var embed:Boolean = getStyle("embedFonts");
+		var textFormat:TextFormat = getStyle("textFormat");
+		var itemWidth:Number = width - 2 * getStyle("borderWidth");
+		var itemHeight:Number = getStyle("itemHeight");
+		while(count--)
+		{
+			if(_textFields.length < numItems)
+			{
+				var depth:int = _textFields.length;
+				var newTextField:TextField = new TextField();
+				newTextField.border = false;
+				newTextField.embedFonts = embed;
+				if(textFormat != null) newTextField.defaultTextFormat = textFormat;
+				newTextField.selectable = false;
+				if(_textFields.length) newTextField.y = _textFields[_textFields.length - 1].y + itemHeight;
+				_textFields.push(newTextField);
+				updateTF(depth);
+				newTextField.height = itemHeight;
+				_textFieldHolder.addChild(newTextField);
+			}
+		}
+	}
+	/**
+	* Check the current number of textfields to see if we need to add or remove any
+	* @return	Boolean flag indicating if any changes were made
+	*/
+	private function updateTextFieldCount():Boolean
+	{
+		if(_textFields.length > _numShown)
+		{
+			var removedTFs:Array = _textFields.splice(_numShown, _textFields.length);
+			for(var i:* in removedTFs)
+			{
+				////trace("removing: " + i + " " + removedTFs[i]);
+				_textFieldHolder.removeChild(removedTFs[i]);
+			}
+			return true;
+		}
+		else if(_textFields.length < _numShown && _listItems.length > _textFields.length) {
+			//////trace("\nadding:  ",_elements.length,_tfs.length);
+			createTF((_listItems.length < _numShown ? _listItems.length : _numShown) - _textFields.length); // calc the number of items to make
+			//createTF(_elements.length - _tfs.length); // calc the number of items to make
+			//createTF(1);	//calc the number of items to make
+			//_tfs.arrange()
+			return true;
+		}
+		return false;
+	}
+	/**
+	* Default style objects
+	*/
+	protected override function styleDefaults():void
+	{
+		setStyle('scrollWidth', 12);
+		setStyle("borderWidth", 1)
+		setStyle("itemHeight", 20);
+		setStyle("textFormat", new TextFormat("Arial", 10, 0x000000));
+		setStyle("embedFonts", false);
+	}
+}
+}
+class ListItem
+{
+	public var label:String;
+	public var data:*;
+	public function ListItem(label:String = "", data:* = null)
+	{
+		this.label = label;
+		this.data = data;
+	}
+}