fit-ui 2.3.5 → 2.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fit-ui",
-  "version": "2.3.5",
+  "version": "2.5.1",
   "title": "Fit.UI",
   "description": "Object Oriented framework for building rich User Interfaces",
   "main": "dist/Fit.UI.js",

package/types/index.d.ts

@@ -2739,6 +2739,13 @@ declare namespace Fit
 			*/
 			public GetSelections(includeInvalid?:boolean):Fit.Controls.DropDownTypeDefs.DropDownItem[];
 			/**
+			* Make DropDown highlight first selectable item when opened.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set value indicating whether input is enabled.
 			* @function InputEnabled
 			* @param {boolean} [val=undefined] - If defined, True enables input, False disables it.
@@ -2802,6 +2809,13 @@ declare namespace Fit
 			*/
 			public OpenDropDown():void;
 			/**
+			* Make DropDown restore scroll position and previously highlighted item when reopened.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
 			* Get/set value used as a placeholder on supported browsers, to indicate expected value or action.
 			* @function Placeholder
 			* @param {string} [val=undefined] - If defined, value is set as placeholder.
@@ -4090,6 +4104,12 @@ declare namespace Fit
 			*/
 			public GetItem(value:string):Fit.Controls.ListViewTypeDefs.ListViewItem | null;
 			/**
+			* Get all items - returns array containing objects with Title (string) and Value (string) properties.
+			* @function GetItems
+			* @returns Fit.Controls.ListViewTypeDefs.ListViewItem[]
+			*/
+			public GetItems():Fit.Controls.ListViewTypeDefs.ListViewItem[];
+			/**
 			* Returns value indicating whether control contains item with specified value.
 			* @function HasItem
 			* @param {string} value - Value of item to check for.
@@ -4103,6 +4123,23 @@ declare namespace Fit
 			*/
 			constructor(controlId?:string);
 			/**
+			* Register event handler fired when item is being selected.
+			Selection can be canceled by returning False.
+			The following arguments are passed to event handler function:
+			Sender (ListView) and Item (with Title (string) and Value (string) properties).
+			* @function OnSelect
+			* @param {Fit.Controls.ListViewTypeDefs.OnSelectEventHandler<this>} cb - Event handler function.
+			*/
+			public OnSelect(cb:Fit.Controls.ListViewTypeDefs.OnSelectEventHandler<this>):void;
+			/**
+			* Register event handler fired when item is selected.
+			The following arguments are passed to event handler function:
+			Sender (ListView) and Item (with Title (string) and Value (string) properties).
+			* @function OnSelected
+			* @param {Fit.Controls.ListViewTypeDefs.OnSelectedEventHandler<this>} cb - Event handler function.
+			*/
+			public OnSelected(cb:Fit.Controls.ListViewTypeDefs.OnSelectedEventHandler<this>):void;
+			/**
 			* Remove item from ListView.
 			* @function RemoveItem
 			* @param {string} value - Value of item to remove.
@@ -4165,6 +4202,14 @@ declare namespace Fit
 			*/
 			public HandleEvent(e?:Event):void;
 			/**
+			* Overridden by control developers (optional).
+			This function can be used to make the picker control automatically highlight the first item.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set max height of control - returns object with Value (number) and Unit (string) properties.
 			* @function MaxHeight
 			* @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
@@ -4225,6 +4270,16 @@ declare namespace Fit
 			public OnShow(cb:Fit.Controls.PickerBaseTypeDefs.BaseEventHandler<this>):void;
 			/**
 			* Overridden by control developers (optional).
+			This function can be used to tell the picker control to persist (remember) its current state between interactions.
+			For instance a TreeView control would remembers its scroll position and highlighted node, while a calendar would
+			remember the previously selected year and month.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
+			* Overridden by control developers (optional).
 			Host control may invoke this function to reveal a selected item in
 			the picker control. Often this means having the item scrolled into view.
 			* @function RevealItemInView
@@ -4299,6 +4354,49 @@ declare namespace Fit
 			public Render(toElement?:HTMLElement):void;
 		}
 		/**
+		* 
+		* @namespace [Fit.Controls.ListViewTypeDefs ListViewTypeDefs]
+		*/
+		namespace ListViewTypeDefs
+		{
+			// Functions defined by Fit.Controls.ListViewTypeDefs
+			/**
+			* OnSelected event handler.
+			* @template TypeOfThis
+			* @callback OnSelectedEventHandler
+			* @param {TypeOfThis} sender - Instance of control.
+			* @param {{ Title: string, Value: string }} item - Selected item.
+			*/
+			type OnSelectedEventHandler<TypeOfThis> = (sender:TypeOfThis, item:{ Title: string, Value: string }) => void;
+			/**
+			* OnSelect event handler.
+			* @template TypeOfThis
+			* @callback OnSelectEventHandler
+			* @param {TypeOfThis} sender - Instance of control.
+			* @param {{ Title: string, Value: string }} item - Selected item.
+			* @returns boolean | void
+			*/
+			type OnSelectEventHandler<TypeOfThis> = (sender:TypeOfThis, item:{ Title: string, Value: string }) => boolean | void;
+			/**
+			* ListView item.
+			* @class [Fit.Controls.ListViewTypeDefs.ListViewItem ListViewItem]
+			*/
+			class ListViewItem
+			{
+				// Properties defined by Fit.Controls.ListViewTypeDefs.ListViewItem
+				/**
+				* Item title.
+				* @member {string} Title
+				*/
+				Title:string;
+				/**
+				* Unique item value.
+				* @member {string} Value
+				*/
+				Value:string;
+			}
+		}
+		/**
 		* Class from which all Picker Controls extend.
 		Control developers must override: GetDomElement, Destroy.
 		Overriding the following functions is optional:
@@ -4374,6 +4472,14 @@ declare namespace Fit
 			*/
 			public HandleEvent(e?:Event):void;
 			/**
+			* Overridden by control developers (optional).
+			This function can be used to make the picker control automatically highlight the first item.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set max height of control - returns object with Value (number) and Unit (string) properties.
 			* @function MaxHeight
 			* @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
@@ -4434,6 +4540,16 @@ declare namespace Fit
 			public OnShow(cb:Fit.Controls.PickerBaseTypeDefs.BaseEventHandler<this>):void;
 			/**
 			* Overridden by control developers (optional).
+			This function can be used to tell the picker control to persist (remember) its current state between interactions.
+			For instance a TreeView control would remembers its scroll position and highlighted node, while a calendar would
+			remember the previously selected year and month.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
+			* Overridden by control developers (optional).
 			Host control may invoke this function to reveal a selected item in
 			the picker control. Often this means having the item scrolled into view.
 			* @function RevealItemInView
@@ -5032,6 +5148,14 @@ declare namespace Fit
 			*/
 			public HandleEvent(e?:Event):void;
 			/**
+			* Overridden by control developers (optional).
+			This function can be used to make the picker control automatically highlight the first item.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set max height of control - returns object with Value (number) and Unit (string) properties.
 			* @function MaxHeight
 			* @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
@@ -5092,6 +5216,16 @@ declare namespace Fit
 			public OnShow(cb:Fit.Controls.PickerBaseTypeDefs.BaseEventHandler<this>):void;
 			/**
 			* Overridden by control developers (optional).
+			This function can be used to tell the picker control to persist (remember) its current state between interactions.
+			For instance a TreeView control would remembers its scroll position and highlighted node, while a calendar would
+			remember the previously selected year and month.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
+			* Overridden by control developers (optional).
 			Host control may invoke this function to reveal a selected item in
 			the picker control. Often this means having the item scrolled into view.
 			* @function RevealItemInView
@@ -5993,6 +6127,12 @@ declare namespace Fit
 			*/
 			public Url(wsUrl?:string):string;
 			/**
+			* Get/set value indicating whether control uses the built-in action menu to ease addition and removal of items.
+			* @function UseActionMenu
+			* @param {boolean} [val=undefined] - If defined, True enables the action menu, False disables it.
+			*/
+			public UseActionMenu(val?:boolean):void;
+			/**
 			* Create instance of WSDropDown control.
 			* @function WSDropDown
 			* @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
@@ -6093,6 +6233,13 @@ declare namespace Fit
 			*/
 			public GetSelections(includeInvalid?:boolean):Fit.Controls.DropDownTypeDefs.DropDownItem[];
 			/**
+			* Make DropDown highlight first selectable item when opened.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set value indicating whether input is enabled.
 			* @function InputEnabled
 			* @param {boolean} [val=undefined] - If defined, True enables input, False disables it.
@@ -6156,6 +6303,13 @@ declare namespace Fit
 			*/
 			public OpenDropDown():void;
 			/**
+			* Make DropDown restore scroll position and previously highlighted item when reopened.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
 			* Get/set value used as a placeholder on supported browsers, to indicate expected value or action.
 			* @function Placeholder
 			* @param {string} [val=undefined] - If defined, value is set as placeholder.
@@ -6746,6 +6900,12 @@ declare namespace Fit
 			*/
 			public GetItem(value:string):Fit.Controls.ListViewTypeDefs.ListViewItem | null;
 			/**
+			* Get all items - returns array containing objects with Title (string) and Value (string) properties.
+			* @function GetItems
+			* @returns Fit.Controls.ListViewTypeDefs.ListViewItem[]
+			*/
+			public GetItems():Fit.Controls.ListViewTypeDefs.ListViewItem[];
+			/**
 			* Returns value indicating whether control contains item with specified value.
 			* @function HasItem
 			* @param {string} value - Value of item to check for.
@@ -6753,6 +6913,23 @@ declare namespace Fit
 			*/
 			public HasItem(value:string):boolean;
 			/**
+			* Register event handler fired when item is being selected.
+			Selection can be canceled by returning False.
+			The following arguments are passed to event handler function:
+			Sender (ListView) and Item (with Title (string) and Value (string) properties).
+			* @function OnSelect
+			* @param {Fit.Controls.ListViewTypeDefs.OnSelectEventHandler<this>} cb - Event handler function.
+			*/
+			public OnSelect(cb:Fit.Controls.ListViewTypeDefs.OnSelectEventHandler<this>):void;
+			/**
+			* Register event handler fired when item is selected.
+			The following arguments are passed to event handler function:
+			Sender (ListView) and Item (with Title (string) and Value (string) properties).
+			* @function OnSelected
+			* @param {Fit.Controls.ListViewTypeDefs.OnSelectedEventHandler<this>} cb - Event handler function.
+			*/
+			public OnSelected(cb:Fit.Controls.ListViewTypeDefs.OnSelectedEventHandler<this>):void;
+			/**
 			* Remove item from ListView.
 			* @function RemoveItem
 			* @param {string} value - Value of item to remove.
@@ -6815,6 +6992,14 @@ declare namespace Fit
 			*/
 			public HandleEvent(e?:Event):void;
 			/**
+			* Overridden by control developers (optional).
+			This function can be used to make the picker control automatically highlight the first item.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set max height of control - returns object with Value (number) and Unit (string) properties.
 			* @function MaxHeight
 			* @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
@@ -6875,6 +7060,16 @@ declare namespace Fit
 			public OnShow(cb:Fit.Controls.PickerBaseTypeDefs.BaseEventHandler<this>):void;
 			/**
 			* Overridden by control developers (optional).
+			This function can be used to tell the picker control to persist (remember) its current state between interactions.
+			For instance a TreeView control would remembers its scroll position and highlighted node, while a calendar would
+			remember the previously selected year and month.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
+			* Overridden by control developers (optional).
 			Host control may invoke this function to reveal a selected item in
 			the picker control. Often this means having the item scrolled into view.
 			* @function RevealItemInView
@@ -7501,6 +7696,14 @@ declare namespace Fit
 			*/
 			public HandleEvent(e?:Event):void;
 			/**
+			* Overridden by control developers (optional).
+			This function can be used to make the picker control automatically highlight the first item.
+			* @function HighlightFirst
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public HighlightFirst(val?:boolean):boolean;
+			/**
 			* Get/set max height of control - returns object with Value (number) and Unit (string) properties.
 			* @function MaxHeight
 			* @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
@@ -7561,6 +7764,16 @@ declare namespace Fit
 			public OnShow(cb:Fit.Controls.PickerBaseTypeDefs.BaseEventHandler<this>):void;
 			/**
 			* Overridden by control developers (optional).
+			This function can be used to tell the picker control to persist (remember) its current state between interactions.
+			For instance a TreeView control would remembers its scroll position and highlighted node, while a calendar would
+			remember the previously selected year and month.
+			* @function PersistView
+			* @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
+			* @returns boolean
+			*/
+			public PersistView(val?:boolean):boolean;
+			/**
+			* Overridden by control developers (optional).
 			Host control may invoke this function to reveal a selected item in
 			the picker control. Often this means having the item scrolled into view.
 			* @function RevealItemInView
@@ -8025,31 +8238,6 @@ declare namespace Fit
 			}
 		}
 		/**
-		* 
-		* @namespace [Fit.Controls.ListViewTypeDefs ListViewTypeDefs]
-		*/
-		namespace ListViewTypeDefs
-		{
-			/**
-			* ListView item.
-			* @class [Fit.Controls.ListViewTypeDefs.ListViewItem ListViewItem]
-			*/
-			class ListViewItem
-			{
-				// Properties defined by Fit.Controls.ListViewTypeDefs.ListViewItem
-				/**
-				* Item title.
-				* @member {string} Title
-				*/
-				Title:string;
-				/**
-				* Unique item value.
-				* @member {string} Value
-				*/
-				Value:string;
-			}
-		}
-		/**
 		* Enum values determining visual appearance of button controls.
 		* @enum {string}
 		*/