TIWCGJQSortableOptions Class
Sortable Options class
IWCGJQCommon.TIWCGJSon
IWCGJQControl.TIWCGJQSortableOptions
IWCGJQGrid.TIWCGJQGroupingViewSortOptions
IWCGJQSortableList.TIWCGJQSortableListOptions
The TIWCGJQSortableOptions type exposes the following members.
| Name | Description | |
|---|---|---|
 | AppendTo | Defines where the helper that moves with the mouse is being appended to during the drag (for example, to resolve overlap/zIndex issues). |
| Axis | If defined, the items can be dragged only horizontally or vertically. Possible values:'x', 'y'. |
| Cancel | Prevents sorting if you start on elements matching the selector. |
| CGJSContainer | Represents property |
 | ClassData | Represents property |
| ConnectWith | Takes a jQuery selector with items that also have sortables applied. If used, the sortable is now connected to the other one-way, so you can drag from this sortable to the other. |
| Containment | Constrains dragging to within the bounds of the specified element - can be a DOM element, 'parent', 'document', 'window', or a jQuery selector. Note: the element specified for containment must have a calculated width and height (though it need not be explicit), so for example, if you have float:left sortable children and specify containment:'parent' be sure to have float:left on the sortable/parent container as well or it will have height: 0, causing undefined behavior. |
| Cursor | Defines the cursor that is being shown while sorting. |
| CursorAt | Moves the sorting element or helper so the cursor always appears to drag from the same position. Coordinates can be given as a hash using a combination of one or two keys: { top, left, right, bottom }. |
| Delay | Time in milliseconds to define when the sorting should start. It helps preventing unwanted drags when clicking on an element. |
| Disabled | Disables (true) or enables (false) the sortable. Can be set when initialising (first creating) the sortable. |
| Distance | Tolerance, in pixels, for when sorting should start. If specified, sorting will not start until after mouse is dragged beyond distance. Can be used to allow for clicks on elements within a handle. |
| DropOnEmpty | If false items from this sortable can't be dropped to an empty linked sortable. |
| ForceHelperSize | If true, forces the helper to have a size. |
| ForcePlaceholderSize | If true, forces the placeholder to have a size. |
| Grid | Snaps the sorting element or helper to a grid, every x and y pixels. Array values: [x, y] |
| Handle | Restricts sort start click to the specified element. |
| Helper | Allows for a helper element to be used for dragging display. The supplied function receives the event and the element being sorted, and should return a DOMElement to be used as a custom proxy helper. Possible values: 'original', 'clone' |
| InstList | Represents property |
| IsStored | Represents property |
| Items | Specifies which items inside the element should be sortable. |
| JSon | Return the Interface of SuperObject (ISuperObject) (Inherited from TIWCGJSon.) |
| JSonEvents[string] | Represents property |
| List | Represents property |
| MemberList | Represents property |
| OnActivate | This event is triggered when using connected lists, every connected list on drag start receives it. |
| OnBeforeStop | This event is triggered when sorting stops, but when the placeholder/helper is still available. |
| OnChange | This event is triggered during sorting, but only when the DOM position has changed. |
| OnCreate | This event is triggered when sortable is created. |
| OnDeactivate | This event is triggered when sorting was stopped, is propagated to all possible connected lists. |
| OnOut | This event is triggered when a sortable item is moved away from a connected list. |
| OnOver | This event is triggered when a sortable item is moved into a connected list. |
| OnReceive | This event is triggered when a connected sortable list has received an item from another list. |
| OnRemove | This event is triggered when a sortable item has been dragged out from the list and into another. |
| OnSort | This event is triggered during sorting. |
| OnStart | This event is triggered when sorting starts. |
| OnStop | This event is triggered when sorting has stopped. |
| OnUpdate | This event is triggered when the user stopped sorting and the DOM position has changed. |
| Opacity | Defines the opacity of the helper while sorting. From 0.01 to 1 |
| Owner | Represents property |
| Placeholder | Class that gets applied to the otherwise white space. |
| PropCount | Represents property |
| PropIndexByName[string] | Represents property |
| PropList | Represents property |
| PropName | Represents property |
| PropNameByIndex[Integer] | Represents property |
| Revert | If set to true, the item will be reverted to its new DOM position with a smooth animation. Optionally, it can also be set to a number that controls the duration of the animation in ms. |
| Scroll | If set to true, the page scrolls when coming to an edge. |
| ScrollSensitivity | Defines how near the mouse must be to an edge to start scrolling. |
| ScrollSpeed | The speed at which the window should scroll once the mouse pointer gets within the scrollSensitivity distance. |
| SObj | Represents property |
| Tolerance | This is the way the reordering behaves during drag. Possible values: 'intersect', 'pointer'. In some setups, 'pointer' is more natural. - intersect: draggable overlaps the droppable at least 50%; - pointer: mouse pointer overlaps the droppable |
| zIndex | Z-index for element/helper while being sorted. |
| Name | Description | |||
|---|---|---|---|---|
 | AddBooleanMember(string,Boolean,Boolean,Boolean) | Represents method | ||
| AddColorMember(string,TIWCGColor,Boolean,Boolean) | Represents method | ||
| AddCurrencyMember(string,Currency,Boolean,Boolean) | Represents method | ||
| AddDoubleMember(string,Double,Boolean,Boolean) | Represents method | ||
| AddDynObjListMember(string,Boolean,Boolean) | Represents method | ||
| AddEnumMember(string,string[],Byte,Boolean,Boolean) | Represents method | ||
| AddEnumSetMember(string,string[],Void,Word,Boolean,Boolean) | Represents method | ||
| AddFuncMember(string,string,string,Boolean,TIWCGJSonFuncClass,Boolean,Boolean) | Represents method | ||
 | AddHTML5(TIWHTMLTag) | Represents method | ||
| AddIntegerMember(string,Integer,Boolean,Boolean) | Represents method | ||
| AddJSonMember(string,TCGJSon,Boolean,Boolean) | Represents method | ||
| AddMembers | The procedure add jquery properties.
| ||
| AddObjListMember(string,TIWCGJSonListClass,Boolean,Boolean,Boolean) | Represents method | ||
| AddObjMember(string,TIWCGJSonClass,Boolean,Boolean,Boolean) | Represents method | ||
| AddSimpleArrayMember(string,Boolean,Boolean,Boolean) | Represents method | ||
| AddStringMember(string,string,Boolean,Boolean) | Represents method | ||
| AddVariantMember(string,Variant,Boolean,Boolean) | Represents method | ||
| AfterConstruction | Represents method | ||
| Assign(TPersistent) | Represents method | ||
| Cancel_ | Cancels a change in the current sortable and reverts it back to how it was before the current sort started. Useful in the stop and receive callback functions. If the sortable item is not being moved from one connected sortable to another: $(this).sortable('cancel'); will cancel the change. If the sortable item is being moved from one connected sortable to another: $(ui.sender).sortable('cancel'); will cancel the change. Useful in the 'receive' callback. | ||
| CheckJSonMember(Integer) | Represents method | ||
| ConvertEnumToString(string) | Represents method | ||
| ConvertSetToString(string,TCGStringArray) | Represents method | ||
| DefaultDisabledValue | Represents method | ||
| Disable | Disables the sortable | ||
| Enable | Enables the sortable | ||
| FreeJSonObj(Integer) | Overloaded. Represents method | ||
| FreeJSonObj(string) | Overloaded. Represents method | ||
| GetBooleanValue(Integer) | Represents method | ||
| GetCGJSContainer | Represents method | ||
| GetColorValue(Integer) | Represents method | ||
| GetCurrencyValue(Integer) | Represents method | ||
| GetCustomJq(string,ISuperObject) | Represents method | ||
| GetDoubleValue(Integer) | Represents method | ||
| GetDynObjListValue(Integer) | Represents method | ||
| GetEnumAsString(Integer) | Represents method | ||
| GetEnumerValue(Integer) | Represents method | ||
| GetEnumSetValue(Integer,Pointer) | Represents method | ||
| GetFixedScript(TIWCGJSonFunc,Boolean) | Represents method | ||
| GetFuncValue(Integer) | Represents method | ||
| GetHTMLName | Represents method | ||
| GetImplComponent | Represents method | ||
| GetIntegerValue(Integer) | Represents method | ||
| GetIsStored | Represents method | ||
| GetItemIndex | Represents method | ||
| GetIWCLName | Represents method | ||
| GetJSon | Represents method | ||
| GetJSonByType(Boolean,Boolean) | Represents method | ||
| GetJSonEx(Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
| GetJSonValue(Integer) | Represents method | ||
| GetJSonValueObj(Integer) | Represents method | ||
| GetMemberJSon(TCGJSonMember,ISuperObject,Boolean,Boolean,string) | Represents method | ||
| GetMemberSetterHandler(TObject,TCGJSonMember) | Represents method | ||
| GetMemberSetterScriptParts(TIWCGResponseMemberList,TIWCGJScript) | Represents method | ||
| GetMembersJSon(TIWCGResponseMemberList,Boolean,Boolean) | Represents method | ||
| GetObjListValue(Integer) | Represents method | ||
| GetObjValue(Integer) | Represents method | ||
| GetOwner | Represents method | ||
| GetPropName | Represents method | ||
| GetSimpleArrayValue(Integer) | Represents method | ||
| GetStringValue(Integer) | Represents method | ||
| GetVariantValue(Integer) | Represents method | ||
| InternalGetJSon(TEachPropJSonProc,Boolean,Boolean,Void,Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
 | IsArray | Represents method | ||
| IsBooleanStored(Integer) | Represents method | ||
| IsColorStored(Integer) | Represents method | ||
| IsCurrencyStored(Integer) | Represents method | ||
| IsDoubleStored(Integer) | Represents method | ||
| IsEnumerStored(Integer) | Represents method | ||
| IsEnumSetStored(Integer) | Represents method | ||
| IsFuncStored(Integer) | Represents method | ||
| IsIntegerStored(Integer) | Represents method | ||
| IsJSonObjStored(string) | Represents method | ||
| IsJSonStored(Integer) | Represents method | ||
| IsObjStored(Integer) | Represents method | ||
| IsStringStored(Integer) | Represents method | ||
| IsVariantStored(Integer) | Represents method | ||
| JsCancel_ | Returns the JavaScript code to Cancel | ||
| jsDisable | Returns the JavaScript code to disable sortable | ||
| jsEnable | Returns the JavaScript code to enable sortable | ||
| JSonEscape | Represents method | ||
| JSonIdent | Represents method | ||
| JSonNameQuote | Represents method | ||
| JsRefresh | Returns the JavaScript code to refresh | ||
| JsRefreshPositions | Returns the JavaScript code to RefreshPositions | ||
| Refresh | Refresh the sortable items. Custom trigger the reloading of all sortable items, causing new items to be recognized. | ||
| RefreshPositions | Refresh the cached positions of the sortables' items. Calling this method refreshes the cached item positions of all sortables. This is usually done automatically by the script and slows down performance. | ||
| ResetProps | Represents method | ||
| SetBooleanValue(Integer,Boolean) | Represents method | ||
| SetColorValue(Integer,TIWCGColor) | Represents method | ||
| SetCurrencyValue(Integer,Currency) | Represents method | ||
| SetDoubleValue(Integer,Double) | Represents method | ||
| SetDynObjListValue(Integer,TIWCGJSonDynObjList) | Represents method | ||
| SetEnumerValue(Integer,Byte) | Represents method | ||
| SetEnumSetValue(Integer,Pointer) | Represents method | ||
| SetFuncValue(Integer,TIWCGJSonFunc) | Represents method | ||
| SetIntegerValue(Integer,Integer) | Represents method | ||
| SetJSonValue(Integer,TCGJSon) | Represents method | ||
| SetObjListValue(Integer,TIWCGJSonList) | Represents method | ||
| SetObjValue(Integer,TIWCGJSon) | Represents method | ||
| SetSimpleArrayValue(Integer,TIWCGJSonSimpleArray) | Represents method | ||
| SetStringValue(Integer,string) | Represents method | ||
| SetVariantValue(Integer,Variant) | Represents method | ||
| StoreProperty(PPropInfo,TObject) | Represents method | ||
| SupportsSetter(TObject,TCGJSonMember) | Represents method |
