Hemi.ui.wideselectHemi JavaScript FrameworkHemi JavaScript Framework/Hemi/Hemi.ui.wideselectHemiThe WideSelect control is a list control which supports buffered and paginated presentation.WideSelect3.1.9Control for buffering and paging large sets of data for display.3.1.9newInstanceParent HTML Node in which the control will be created.Click event handler.Paginate event handler.Creates a new WideSelectInstance object.Instance of a WideSelect control.WideSelectItem3.1.9Object representing an item in the WideSelect control.nameVisible name of the item.dataThe data referenced or held by the item.objectThe HTML object used to display the item.idUnique identifier.indexIndex of this item in the items array.ImportPageItem3.1.9Object construct used to bulk load paginated items.labelName of the item.idUnique identifiervalueValue of the item.indexIndex of this item in the items array.WideSelectInstance3.1.9A buffering and pagination control for displaying large and incremental sets of data.object_idUnique instance identifier.object_versionVersion of the object class.object_typeThe type of this object.ready_stateObject load and execution state. Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.object_configObject API structure for storing sub structures: object_config.pointers and object_config.status.getObjectIdThe unique object instance id.Returns the unique id of the object.getObjectTypeThe type of the object instance.Returns the type of the object.getObjectVersionThe version of the object instance.Returns the version of the object.getReadyStateThe object ready state.Returns the state of the object.onbuffercommittedThe WideSelect control for which the buffer was committed.Message published to all subscribers when a buffered resultset was committed; being completely rendered and/or paginated.onresultclickThe WideSelect control for which the item state was changed.Message published to all subscribers when the state changes for a WideSelectItem object.handle_pagenavigateStatic parameter: onpagenavigate.Current page index.Handler is specified in the WideSelectInstance constructor; newInstance.getPointersThe object_config.pointers substructure.Returns the object_config.pointers sub structure.setMultipleBit indicating whether multiple selection is enabled.Sets whether multiple selection is enabled.getMultipleBit indicating whether multiple selection is enabled.Returns whether multiple selection is enabled.setMaximumItemsMaximum number of items supported by the control.Sets the maximum number of items supported by the control. Specify zero to indicate no limit. Any items over the maximum when rollover is enabled will cause the top-most item to be removed. When rollover is disabled, the addItem method will fail on the last item.getMaximumItemsMaximum number of items supported by the control. Zero indicates no limit.Returns the maximum number of items supported by the control.setMaximumPageItemsMaximum number of items to be displayed per page.Sets the maximum number of items displayed per page, if paging is enabled.getMaximumPageItemsMaximum number of items displayed per page.Returns the maximum number of items to display per page, if paging is enabled.getCurrentPageItemCountNumber of items in the current page.Returns the number of items in the current page.getContainerHTML Node in which the control is created.Returns the the HTML Node in which the control is created.getBufferMarkCurrent insert position in the buffer.Returns the current position in the buffer, after which additional items will be rendered.setResultHandlerFunction pointer to click handler.Specifies the handler to invoke when a result item is activated.getBufferSizeCurrent size of the buffer.Returns the current size of the buffer.getItemSizeCount of all rendered and paginated items.Returns the current size of all items in the control.getItemsArray of WideSelectItem objects.Returns an array of WideSelectItem objects.getItemIndex of WideSelectItem in items array.WideSelectItem object.Returns the WideSelectItem object at the specified index.getActiveItemWideSelectItem object.Returns the selected WideSelectItem object.setCanRequestBit indicating whether the control can be requested.Specifies whether the WideSelect control can be requested. The request featureset is used when the control is a pop-up or conditionally visible.setIsPagingBit indicating whether the control is in paging mode.Specifies whether the WideSelect control is in paging mode. Changing this value will clear paged items, and the control will need to be repopulated.getIsPagingBit indicating whether the control is in paging mode.Returns whether the WideSelect control is in paging mode.setPageStopBit indicating whether the control should stop expecting more data.Specifies whether the WideSelect control should stop expecting more data, when in paging mode.getPageStopBit indicating whether the control is no longer expecting additional data.Returns whether the WideSelect control is no longer expecting data.setAutoCommitBit indicating whether the control will automatically render items as they are added.Specifies whether the WideSelect control should render items as they are added. If buffering is enabled, items will automatically begin rendering.setAutoScrollBit indicating whether the control will automatically scroll to the last rendered item.Specifies whether the WideSelect control will automatically scroll to the last rendered item.setAutoSelectBit indicating whether the control will automatically select the last rendered item.Specifies whether the WideSelect control will automatically select the last rendered item.setMaximumRolloverBit indicating whether the control will rollover when the maximum number of items is reached.Specifies whether the WideSelect control will rollover when the maximum number of items is reached; deleting the first item and adding the new item to the end. If disabled and a maximum limit is stipulated, then new items won't be added.deselectAllItemsDeselects all selected items in the WideSelect control.initInitializes the WideSelect control. Specify avoid so the Space service doesn't drill into the results _handle_window_destroyMessage subscription handler invoked when the host window is unloading.setIsBufferedBit indicating whether the control should buffer new items.Specifies whether the control should buffer new items. Buffered items are incrementally rendered.setBufferOffsetNumber of items to render at a time.Specifies the number of items to be rendered at a time.setBufferDelayNumber of milleseconds.Specifies the number of milliseconds to pause between rendering the buffer offset.destroyCleans up internal pointers, empties buffers, and removes HTML artifacts. Invoked when the window is unloaded.addItemName of the item. The name is used for the label.The value of the item.Adds an item to the WideSelect control. The item is displayed based on buffering, and maximum display settings and restrictions. Use pageItem to add items for pagination. Specify a value of "_avoid" to create non-selectable labels._handle_buffer_checkInternal operation for testing the state of the buffer.commitBufferCommits the buffer up to the next buffer offset. Invoked automatically when AutoCommit is enabled._handle_commit_bufferInternal operation for committing the buffer into the WideSelectItem array.pageItemName of the item. The name is used for the label.The value of the item.Adds an item for pagination within the WideSelect control. The item is displayed based on pagination settings.updatePageRenders the current page of WideSelectItem objects._addItemName of the item. The name is used for the label.The value of the item.Creates and renders a WideSelectItem object._handle_mouseoverEvent objectInternal handler for mouseover event._handle_mouseoutEvent objectInternal handler for mouseout event.setActiveItemIndex of WideSelectItem to activate.Selects the specified WideSelectItem . Blocks publication of the onresultclick message.selectItemIndex of WideSelectItem to activate.Bit indicating whether to block the onresultclick message.Selects the specified WideSelectItem.scrollToItemIndex of WideSelectItem to activate.Scrolls to control to the specified WideSelectItem._handle_clickOverloaded variant which may be an event or index.Bit indicating whether the "onresultclick" message should be suppressed.Internal handler for mouseout event.clearItemIndex of WideSelectItem to remove.Removes the specified WideSelectItem.clearItemsRemoves all WideSelectItem objects.clearPagingValuesRemoves all paged WideSelectItem objects.resetClears both paged and non-paged WideSelectItem objects, and ends any active request.moveFirstMoves the paginated result set to the first page. Invokes any specified handle_pagenavigate handler.moveLastMoves the paginated result set to the last page. Invokes any specified handle_pagenavigate handler.getCanMoveNextBit indicating whether there is an additional page.Checks whether there is an additional page beyond the current.getCanMovePreviousBit indicating whether there is a previous page.Checks whether there is a previous page prior to the current.moveNextBit indicating whether the operation is a test.Moves the paginated result set to the next page. Invokes any specified handle_pagenavigate handler.movePreviousBit indicating whether the operation is a test.Moves the paginated result set to the previous page. Invokes any specified handle_pagenavigate handler.importPageItemsArray of ImportPageItem objects.Bit indicating whether this is the last page.Imports a variant-length array of data into the paginated set of WideSelectItem objects.getIsRequestedBit indicating whether the control is currently requested for display.Returns a bit indicating whether or not the control is requested for display.requestIf requesting is enabled, displays and positions the WideSelectInstance control.endRequestHides the WideSelectInstance control if requested.alignControlHTML Node to which the control should be aligned.Aligns the WideSelectInstance to the bottom border of the specified HTML Node.The WideSelect control is a list control which supports buffered and paginated presentation.Hemi_api.htmlAPI Index