rwt.widgets.util.SelectionManager.js Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2004, 2014 1&1 Internet AG, Germany, http://www.1und1.de,
* EclipseSource and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* 1&1 Internet AG and others - original API and implementation
* EclipseSource - adaptation for the Eclipse Remote Application Platform
******************************************************************************/
/**
* This class represents a selection and manage incoming events for widgets
* which need selection support.
*/
rwt.qx.Class.define("rwt.widgets.util.SelectionManager",
{
extend : rwt.qx.Target,
/*
*****************************************************************************
CONSTRUCTOR
*****************************************************************************
*/
construct : function(vBoundedWidget)
{
this.base(arguments);
this._selectedItems = new rwt.widgets.util.Selection();
if (vBoundedWidget != null) {
this.setBoundedWidget(vBoundedWidget);
}
},
/*
*****************************************************************************
EVENTS
*****************************************************************************
*/
events:
{
/**
* Fired on a selection change. The "data" proeprty is set to an array of
* selected items as returned by {@link #getSelectedItems}.
**/
"changeSelection" : "rwt.event.DataEvent"
},
/*
*****************************************************************************
PROPERTIES
*****************************************************************************
*/
properties :
{
/** This contains the currently assigned widget (qx.ui.form.List, ...) */
boundedWidget :
{
check : "rwt.widgets.base.Widget",
nullable : true
},
/** Should multiple selection be allowed? */
multiSelection :
{
check: "Boolean",
init : true
},
/** Enable drag selection? */
dragSelection :
{
check : "Boolean",
init : true
},
/** Should the user be able to select */
canDeselect :
{
check : "Boolean",
init : true
},
/** Should a change event be fired? */
fireChange :
{
check : "Boolean",
init : true
},
/** The current anchor in range selections. */
anchorItem :
{
check : "Object",
nullable : true,
apply : "_applyAnchorItem",
event : "changeAnchorItem"
},
/** The last selected item */
leadItem :
{
check : "Object",
nullable : true,
apply : "_applyLeadItem",
event : "changeLeadItem"
},
/** Grid selection */
multiColumnSupport :
{
check : "Boolean",
init : false
}
},
/*
*****************************************************************************
MEMBERS
*****************************************************************************
*/
members :
{
/*
---------------------------------------------------------------------------
APPLY ROUTINES
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @param value {var} Current value
* @param old {var} Previous value
*/
_applyAnchorItem : function(value, old)
{
if (old) {
this.renderItemAnchorState(old, false);
}
if (value) {
this.renderItemAnchorState(value, true);
}
},
/**
* TODOC
*
* @type member
* @param value {var} Current value
* @param old {var} Previous value
*/
_applyLeadItem : function(value, old)
{
if (old) {
this.renderItemLeadState(old, false);
}
if (value) {
this.renderItemLeadState(value, true);
}
},
/*
---------------------------------------------------------------------------
MAPPING TO BOUNDED WIDGET
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
_getFirst : function() {
return this.getBoundedWidget().getFirstVisibleChild();
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
_getLast : function() {
return this.getBoundedWidget().getLastVisibleChild();
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
getFirst : function()
{
var vItem = this._getFirst();
if (vItem) {
return vItem.getEnabled() ? vItem : this.getNext(vItem);
}
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
getLast : function()
{
var vItem = this._getLast();
if (vItem) {
return vItem.getEnabled() ? vItem : this.getPrevious(vItem);
}
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
getItems : function() {
return this.getBoundedWidget().getChildren();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getNextSibling : function(vItem) {
return vItem.getNextSibling();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getPreviousSibling : function(vItem) {
return vItem.getPreviousSibling();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var | null} TODOC
*/
getNext : function(vItem)
{
while (vItem)
{
vItem = this.getNextSibling(vItem);
if (!vItem) {
break;
}
if (this.getItemEnabled(vItem)) {
return vItem;
}
}
return null;
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var | null} TODOC
*/
getPrevious : function(vItem)
{
while (vItem)
{
vItem = this.getPreviousSibling(vItem);
if (!vItem) {
break;
}
if (this.getItemEnabled(vItem)) {
return vItem;
}
}
return null;
},
/**
* TODOC
*
* @type member
* @param vItem1 {var} TODOC
* @param vItem2 {var} TODOC
* @return {boolean} TODOC
*/
isBefore : function(vItem1, vItem2)
{
var cs = this.getItems();
return cs.indexOf(vItem1) < cs.indexOf(vItem2);
},
/**
* TODOC
*
* @type member
* @param vItem1 {var} TODOC
* @param vItem2 {var} TODOC
* @return {var} TODOC
*/
isEqual : function(vItem1, vItem2) {
return vItem1 == vItem2;
},
/*
---------------------------------------------------------------------------
MAPPING TO ITEM PROPERTIES
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemHashCode : function(vItem) {
return vItem.toHashCode();
},
/*
---------------------------------------------------------------------------
MAPPING TO ITEM DIMENSIONS
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @param vTopLeft {var} TODOC
* @return {void}
*/
scrollItemIntoView : function(vItem, vTopLeft) {
vItem.scrollIntoView(vTopLeft);
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemLeft : function(vItem) {
return vItem.getOffsetLeft();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemTop : function(vItem) {
return vItem.getOffsetTop();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemWidth : function(vItem) {
return vItem.getOffsetWidth();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemHeight : function(vItem) {
return vItem.getOffsetHeight();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemEnabled : function(vItem) {
return vItem.getEnabled();
},
/*
---------------------------------------------------------------------------
ITEM STATE MANAGMENT
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @param vIsSelected {var} TODOC
* @return {void}
*/
renderItemSelectionState : function( vItem, vIsSelected ) {
vItem.toggleState( "selected", vIsSelected );
if( vItem.handleStateChange ) {
vItem.handleStateChange();
}
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @param vIsAnchor {var} TODOC
* @return {void}
*/
renderItemAnchorState : function( vItem, vIsAnchor ) {
vItem.toggleState( "anchor", vIsAnchor );
if( vItem.handleStateChange != null ) {
vItem.handleStateChange();
}
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @param vIsLead {var} TODOC
* @return {void}
*/
renderItemLeadState : function( vItem, vIsLead ) {
vItem.toggleState( "lead", vIsLead );
if( vItem.handleStateChange != null ) {
vItem.handleStateChange();
}
},
/*
---------------------------------------------------------------------------
SELECTION HANDLING
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getItemSelected : function(vItem) {
return this._selectedItems.contains(vItem);
},
/**
* Make a single item selected / not selected
*
* #param vItem[rwt.widgets.base.Widget]: Item which should be selected / not selected
* #param vSelected[Boolean]: Should this item be selected?
*
* @type member
* @param vItem {var} TODOC
* @param vSelected {var} TODOC
* @return {void}
*/
setItemSelected : function(vItem, vSelected)
{
switch(this.getMultiSelection())
{
// Multiple item selection is allowed
case true:
if (!this.getItemEnabled(vItem)) {
return;
}
// If selection state is not to be changed => return
if (this.getItemSelected(vItem) == vSelected) {
return;
}
// Otherwise render new state
this.renderItemSelectionState(vItem, vSelected);
// Add item to selection hash / delete it from there
if( vSelected ) {
this._selectedItems.add( vItem );
} else {
this._selectedItems.remove( vItem );
}
// Dispatch change Event
this._dispatchChange();
break;
// Multiple item selection is NOT allowed
case false:
var item0 = this.getSelectedItems()[0];
if (vSelected)
{
// Precheck for any changes
var old = item0;
if (this.isEqual(vItem, old)) {
return;
}
// Reset rendering of previous selected item
if (old != null) {
this.renderItemSelectionState(old, false);
}
// Render new item as selected
this.renderItemSelectionState(vItem, true);
// Reset current selection hash
this._selectedItems.removeAll();
// Add new one
this._selectedItems.add(vItem);
// Dispatch change Event
this._dispatchChange();
}
else
{
// Pre-check if item is currently selected
// Do not allow deselection in single selection mode
if (!this.isEqual(item0, vItem))
{
// Reset rendering as selected item
this.renderItemSelectionState(vItem, false);
// Dispatch change Event
this._dispatchChange();
}
}
break;
}
},
/**
* Get the selected items (objects)
*
* @type member
* @return {var} TODOC
*/
getSelectedItems : function() {
return this._selectedItems.toArray();
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
getSelectedItem : function() {
return this._selectedItems.getFirst();
},
/**
* Select given items
*
* #param vItems[Array of Widgets]: Items to select
*
* @type member
* @param vItems {var} TODOC
* @return {void}
*/
setSelectedItems : function(vItems)
{
var oldVal = this._getChangeValue();
// Temporary disabling of event fire
var oldFireChange = this.getFireChange();
this.setFireChange(false);
// Deselect all currently selected items
this._deselectAll();
// Apply new selection
var vItem;
var vItemLength = vItems.length;
for (var i=0; i (this.getItemTop(oItem) - 1) ? this.getPrevious(oItem) : this.getNext(oItem)) || oItem);
}
if (!this.getItemSelected(oItem)) {
this.renderItemSelectionState(oItem, true);
}
// Clear up and add new one
// this._selectedItems.removeAll();
this._selectedItems.add(oItem);
this._addToCurrentSelection = true;
}
// ********************************************************************
// Mode #2: (De-)Select item range in mouse drag session
// ********************************************************************
else if (this._activeDragSession && bOver)
{
if (oldLead) {
this._deselectItemRange(currentAnchorItem, oldLead);
}
// Drag down
if (this.isBefore(currentAnchorItem, oItem))
{
if (this._addToCurrentSelection) {
this._selectItemRange(currentAnchorItem, oItem, false);
} else {
this._deselectItemRange(currentAnchorItem, oItem);
}
}
// Drag up
else
{
if (this._addToCurrentSelection) {
this._selectItemRange(oItem, currentAnchorItem, false);
} else {
this._deselectItemRange(oItem, currentAnchorItem);
}
}
// a little bit hacky, but seems to be a fast way to detect if we slide to top or to bottom
this.scrollItemIntoView((this.getBoundedWidget().getScrollTop() > (this.getItemTop(oItem) - 1) ? this.getPrevious(oItem) : this.getNext(oItem)) || oItem);
}
// ********************************************************************
// Mode #3: Add new item to current selection (ctrl pressed)
// ********************************************************************
else if (this.getMultiSelection() && vCtrlKey && !vShiftKey)
{
if (!this._activeDragSession) {
this._addToCurrentSelection = !(this.getCanDeselect() && this.getItemSelected(oItem));
}
this.setItemSelected(oItem, this._addToCurrentSelection);
this.setAnchorItem(oItem);
}
// ********************************************************************
// Mode #4: Add new (or continued) range to selection
// ********************************************************************
else if (this.getMultiSelection() && vCtrlKey && vShiftKey)
{
if (!this._activeDragSession) {
this._addToCurrentSelection = !(this.getCanDeselect() && this.getItemSelected(oItem));
}
if (this._addToCurrentSelection) {
this._selectItemRange(currentAnchorItem, oItem, false);
} else {
this._deselectItemRange(currentAnchorItem, oItem);
}
}
// ********************************************************************
// Mode #5: Replace selection with new range selection
// ********************************************************************
else if (this.getMultiSelection() && !vCtrlKey && vShiftKey)
{
if (this.getCanDeselect()) {
this._selectItemRange(currentAnchorItem, oItem, true);
}
else
{
if (oldLead) {
this._deselectItemRange(currentAnchorItem, oldLead);
}
this._selectItemRange(currentAnchorItem, oItem, false);
}
}
// Recover change event status
this.setFireChange(oldFireChange);
// Dispatch change Event
if (oldFireChange && this._hasChanged(oldVal)) {
this._dispatchChange();
}
},
/*
---------------------------------------------------------------------------
KEY EVENT HANDLER
---------------------------------------------------------------------------
*/
/**
* Handles key event to perform selection and navigation
*
* @type member
* @param vDomEvent {rwt.event.KeyEvent} event object
* @return {void}
*/
handleKeyPress : function(vDomEvent)
{
var oldVal = this._getChangeValue();
// Temporary disabling of event fire
var oldFireChange = this.getFireChange();
this.setFireChange(false);
// Ctrl+A: Select all
if (vDomEvent.getKeyIdentifier() == "A" && vDomEvent.isCtrlPressed())
{
if (this.getMultiSelection())
{
this._selectAll();
// Update lead item to this new last
// (or better here: first) selected item
this.setLeadItem(this.getFirst());
}
}
// Default operation
else
{
var aIndex = this.getAnchorItem();
var itemToSelect = this.getItemToSelect(vDomEvent);
if (itemToSelect && this.getItemEnabled(itemToSelect))
{
// Update lead item to this new last selected item
this.setLeadItem(itemToSelect);
// Scroll new item into view
this.scrollItemIntoView(itemToSelect);
// Stop event handling
vDomEvent.preventDefault();
// Select a range
if (vDomEvent.isShiftPressed() && this.getMultiSelection())
{
// Make it a little bit more failsafe:
// Set anchor if not given already. Allows us to select
// a range without any previous selection.
if (aIndex == null) {
this.setAnchorItem(itemToSelect);
}
// Select new range (and clear up current selection first)
this._selectItemRange(this.getAnchorItem(), itemToSelect, true);
}
else if (!vDomEvent.isCtrlPressed())
{
// Clear current selection
this._deselectAll();
// Update new item to be selected
this.renderItemSelectionState(itemToSelect, true);
// Add item to new selection
this._selectedItems.add(itemToSelect);
// Update anchor to this new item
// (allows following shift range selection)
this.setAnchorItem(itemToSelect);
}
else if (vDomEvent.getKeyIdentifier() == "Space")
{
if (this._selectedItems.contains(itemToSelect))
{
// Update new item to be selected
this.renderItemSelectionState(itemToSelect, false);
// Add item to new selection
this._selectedItems.remove(itemToSelect);
// Fix anchor item
this.setAnchorItem(this._selectedItems.getFirst());
}
else
{
// Clear current selection
if (!vDomEvent.isCtrlPressed() || !this.getMultiSelection()) {
this._deselectAll();
}
// Update new item to be selected
this.renderItemSelectionState(itemToSelect, true);
// Add item to new selection
this._selectedItems.add(itemToSelect);
// Update anchor to this new item
// (allows following shift range selection)
this.setAnchorItem(itemToSelect);
}
}
}
}
// Recover change event status
this.setFireChange(oldFireChange);
// Dispatch change Event
if (oldFireChange && this._hasChanged(oldVal)) {
this._dispatchChange();
}
},
/**
* TODOC
*
* @type member
* @param vKeyboardEvent {var} TODOC
* @return {null | var} TODOC
*/
getItemToSelect : function(vKeyboardEvent)
{
// Don't handle ALT here
if (vKeyboardEvent.isAltPressed()) {
return null;
}
// Handle event by key identifier
switch(vKeyboardEvent.getKeyIdentifier())
{
case "Home":
return this.getHome(this.getLeadItem());
case "End":
return this.getEnd(this.getLeadItem());
case "Down":
return this.getDown(this.getLeadItem());
case "Up":
return this.getUp(this.getLeadItem());
case "Left":
return this.getLeft(this.getLeadItem());
case "Right":
return this.getRight(this.getLeadItem());
case "PageUp":
return this.getPageUp(this.getLeadItem()) || this.getHome(this.getLeadItem());
case "PageDown":
return this.getPageDown(this.getLeadItem()) || this.getEnd(this.getLeadItem());
case "Space":
if (vKeyboardEvent.isCtrlPressed()) {
return this.getLeadItem();
}
}
return null;
},
/*
---------------------------------------------------------------------------
CHANGE HANDLING
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @return {void}
*/
_dispatchChange : function()
{
if (!this.getFireChange()) {
return;
}
if (this.hasEventListeners("changeSelection")) {
this.dispatchEvent(new rwt.event.DataEvent("changeSelection", this.getSelectedItems()), true);
}
},
/**
* TODOC
*
* @type member
* @param sOldValue {String} TODOC
* @return {var} TODOC
*/
_hasChanged : function(sOldValue) {
return sOldValue != this._getChangeValue();
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
_getChangeValue : function() {
return this._selectedItems.getChangeValue();
},
/*
---------------------------------------------------------------------------
POSITION HANDLING
---------------------------------------------------------------------------
*/
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
getHome : function() {
return this.getFirst();
},
/**
* TODOC
*
* @type member
* @return {var} TODOC
*/
getEnd : function() {
return this.getLast();
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getDown : function(vItem)
{
if (!vItem) {
return this.getFirst();
}
return this.getMultiColumnSupport() ? (this.getUnder(vItem) || this.getLast()) : this.getNext(vItem);
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getUp : function(vItem)
{
if (!vItem) {
return this.getLast();
}
return this.getMultiColumnSupport() ? (this.getAbove(vItem) || this.getFirst()) : this.getPrevious(vItem);
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {null | var} TODOC
*/
getLeft : function(vItem)
{
if (!this.getMultiColumnSupport()) {
return null;
}
return !vItem ? this.getLast() : this.getPrevious(vItem);
},
/**
* TODOC
*
* @type member
* @param vItem {var} TODOC
* @return {null | var} TODOC
*/
getRight : function(vItem)
{
if (!this.getMultiColumnSupport()) {
return null;
}
return !vItem ? this.getFirst() : this.getNext(vItem);
},
/*
---------------------------------------------------------------------------
PAGE HANDLING
---------------------------------------------------------------------------
*/
/**
* Jump a "page" up.
*
* #param vItem[rwt.widgets.base.Widget]: Relative to this widget
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getPageUp : function()
{
// Find next item
var nextItem = this.getLeadItem();
if (!nextItem) {
nextItem = this.getFirst();
}
var vBoundedWidget = this.getBoundedWidget();
if( vBoundedWidget.isCreated() ) {
var vParentScrollTop = vBoundedWidget.getScrollTop();
var vParentClientHeight = vBoundedWidget.getClientHeight();
// Normally we should reach the status "lead" for the
// nextItem after two iterations.
var tryLoops = 0;
while (tryLoops < 2)
{
while (nextItem && (this.getItemTop(nextItem) - this.getItemHeight(nextItem) >= vParentScrollTop)) {
nextItem = this.getUp(nextItem);
}
// This should never occour after the fix above
if (nextItem == null) {
break;
}
// If the nextItem is not anymore the leadItem
// Means: There has occured a change.
// We break here. This is normally the second step.
if (nextItem != this.getLeadItem())
{
// be sure that the top is reached
this.scrollItemIntoView(nextItem, true);
break;
}
// Update scrolling (this is normally the first step)
vBoundedWidget.setScrollTop(vParentScrollTop - vParentClientHeight - this.getItemHeight(nextItem));
// Use the real applied value instead of the calulated above
vParentScrollTop = vBoundedWidget.getScrollTop();
// Increment counter
tryLoops++;
}
}
return nextItem;
},
/**
* Jump a "page" down.
*
* #param vItem[rwt.widgets.base.Widget]: Relative to this widget
*
* @type member
* @param vItem {var} TODOC
* @return {var} TODOC
*/
getPageDown : function()
{
// Find next item
var nextItem = this.getLeadItem();
if (!nextItem) {
nextItem = this.getFirst();
}
var vBoundedWidget = this.getBoundedWidget();
if( vBoundedWidget.isCreated() ) {
var vParentScrollTop = vBoundedWidget.getScrollTop();
var vParentClientHeight = vBoundedWidget.getClientHeight();
// Normally we should reach the status "lead" for the
// nextItem after two iterations.
var tryLoops = 0;
while (tryLoops < 2)
{
// Find next
while (nextItem && ((this.getItemTop(nextItem) + (2 * this.getItemHeight(nextItem))) <= (vParentScrollTop + vParentClientHeight))) {
nextItem = this.getDown(nextItem);
}
// This should never occour after the fix above
if (nextItem == null) {
break;
}
// If the nextItem is not anymore the leadItem
// Means: There has occured a change.
// We break here. This is normally the second step.
if (nextItem != this.getLeadItem()) {
break;
}
// Update scrolling (this is normally the first step)
vBoundedWidget.setScrollTop(vParentScrollTop + vParentClientHeight - 2 * this.getItemHeight(nextItem));
// Use the real applied value instead of the calulated above
vParentScrollTop = vBoundedWidget.getScrollTop();
// Increment counter
tryLoops++;
}
}
return nextItem;
}
},
/*
*****************************************************************************
DESTRUCTOR
*****************************************************************************
*/
destruct : function() {
this._disposeObjects("_selectedItems");
}
});
© 2015 - 2025 Weber Informatics LLC | Privacy Policy