com.icesoft.faces.component.ext.RowSelector Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-compat Show documentation
Show all versions of icefaces-compat Show documentation
${icefaces.product.name} Compat Component Library
/*
* Copyright 2004-2012 ICEsoft Technologies Canada Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an "AS
* IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package com.icesoft.faces.component.ext;
import com.icesoft.faces.context.effects.JavascriptContext;
import com.icesoft.faces.component.CSS_DEFAULT;
import com.icesoft.faces.component.ext.renderkit.TableRenderer;
import com.icesoft.faces.component.ext.taglib.Util;
import javax.faces.component.UIComponent;
import javax.faces.component.UIData;
import javax.faces.component.UIPanel;
import javax.faces.context.FacesContext;
import javax.faces.el.MethodBinding;
import javax.faces.el.ValueBinding;
import javax.faces.el.MethodNotFoundException;
import javax.faces.el.EvaluationException;
import javax.faces.event.FacesEvent;
import javax.faces.event.PhaseId;
import javax.faces.FacesException;
import javax.faces.application.NavigationHandler;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* Created by IntelliJ IDEA. User: rmayhew Date: Aug 28, 2006 Time: 12:45:26 PM
* To change this template use File | Settings | File Templates.
*/
public class RowSelector extends UIPanel {
private Boolean value;
private Boolean toggleOnClick;
private Boolean toggleOnInput;
// private Listener
private Boolean multiple;
private Boolean enhancedMultiple;
private String mouseOverClass;
private String selectedClass;
private String selectedMouseOverClass;
private String tabindex;
private MethodBinding selectionListener;
private MethodBinding selectionAction;
private MethodBinding clickListener;
private MethodBinding clickAction;
private Integer clickedRow;
private Boolean immediate;
private Integer dblClickDelay;
private Boolean preStyleOnSelection;
private String renderedOnUserRole = null;
transient private List selectedRowsList = new ArrayList();
private Boolean keyboardNavigationEnabled;
private Boolean singleRowAutoSelect;
public static final String COMPONENT_TYPE = "com.icesoft.faces.RowSelector";
public static final String COMPONENT_FAMILY =
"com.icesoft.faces.RowSelectorFamily";
public static final int DEFAULT_DBLCLICK_DELAY = 200;
//to deselect multiple rows with paginator we need to keep track of whole
//selection.
private List currentSelection = new ArrayList();
public RowSelector(){
JavascriptContext
.includeLib(JavascriptContext.ICE_EXTRAS, getFacesContext());
}
public String getFamily() {
return COMPONENT_FAMILY;
}
public Boolean getValue() {
ValueBinding vb = getValueBinding("value");
if (vb != null) {
return (Boolean) vb.getValue(getFacesContext());
}
if (value != null) {
return value;
}
return Boolean.FALSE;
}
public void setValue(Boolean value) {
ValueBinding vb = getValueBinding("value");
if (vb != null) {
vb.setValue(getFacesContext(), value);
} else {
this.value = value;
}
//the value can be changed by decode as well as application code, so this
//is the single point to keep selection state in synch
try {
updateCurrentSelection(value);
//this catch satisfy JUNIT test, where its not a JSF environment
} catch (Exception e){e.printStackTrace();}
}
private void updateCurrentSelection(Boolean value) {
HtmlDataTable dataTable = getParentDataTable(this);
int rowindex = dataTable.getRowIndex();
if (value.booleanValue()) {
currentSelection.add(new Integer(rowindex));
} else {
currentSelection.remove(new Integer(rowindex));
}
}
public Integer getClickedRow() {
ValueBinding vb = getValueBinding("clickedRow");
if (vb != null) {
return (Integer) vb.getValue(getFacesContext());
}
if (clickedRow != null) {
return clickedRow;
}
return new Integer(-1);
}
public void setClickedRow(Integer clickedRow) {
ValueBinding vb = getValueBinding("clickedRow");
if (vb != null) {
vb.setValue(getFacesContext(), clickedRow);
} else {
this.clickedRow = clickedRow;
}
}
public boolean isEnhancedMultiple() {
if (enhancedMultiple != null) {
return enhancedMultiple.booleanValue();
}
ValueBinding vb = getValueBinding("enhancedMultiple");
return vb != null ?
((Boolean) vb.getValue(getFacesContext())).booleanValue() :
false;
}
public void setEnhancedMultiple(boolean enhancedMultiple) {
this.enhancedMultiple = new Boolean(enhancedMultiple);
}
public Boolean getMultiple() {
ValueBinding vb = getValueBinding("multiple");
if (vb != null) {
return (Boolean) vb.getValue(getFacesContext());
}
if (multiple != null) {
return multiple;
}
return Boolean.FALSE;
}
public void setMultiple(Boolean multiple) {
this.multiple = multiple;
}
public Boolean getToggleOnClick() {
ValueBinding vb = getValueBinding("toggleOnClick");
if (vb != null) {
return (Boolean) vb.getValue(getFacesContext());
}
if (toggleOnClick != null) {
return toggleOnClick;
}
return Boolean.TRUE;
}
public void setToggleOnClick(Boolean toggleOnClick) {
this.toggleOnClick = toggleOnClick;
}
public Boolean getToggleOnInput() {
ValueBinding vb = getValueBinding("toggleOnInput");
if (vb != null) {
return (Boolean) vb.getValue(getFacesContext());
}
if (toggleOnInput != null) {
return toggleOnInput;
}
return Boolean.TRUE;
}
public void setToggleOnInput(Boolean toggleOnInput) {
this.toggleOnInput = toggleOnInput;
}
public String getMouseOverClass() {
return Util.getQualifiedStyleClass(this,
mouseOverClass,
CSS_DEFAULT.ROW_SELECTION_MOUSE_OVER,
"mouseOverClass");
}
public void setMouseOverClass(String mouseOverClass) {
this.mouseOverClass = mouseOverClass;
}
public String getSelectedClass() {
return Util.getQualifiedStyleClass(this,
selectedClass,
CSS_DEFAULT.ROW_SELECTION_SELECTED,
"selectedClass");
}
public void setSelectedClass(String selectedClass) {
this.selectedClass = selectedClass;
}
public String getSelectedMouseOverClass() {
return Util.getQualifiedStyleClass(this,
selectedMouseOverClass,
CSS_DEFAULT.ROW_SELECTION_SELECTED_MOUSE_OVER,
"selectedMouseOverClass");
}
public void setSelectedMouseOverClass(String selectedMouseOverClass) {
this.selectedMouseOverClass = selectedMouseOverClass;
}
public MethodBinding getSelectionListener() {
return selectionListener;
}
public void setSelectionListener(MethodBinding selectionListener) {
this.selectionListener = selectionListener;
}
public MethodBinding getSelectionAction() {
return selectionAction;
}
public void setSelectionAction(MethodBinding selectionListener) {
this.selectionAction = selectionListener;
}
public MethodBinding getClickListener() {
return clickListener;
}
public void setClickListener(MethodBinding clickListener) {
this.clickListener = clickListener;
}
public MethodBinding getClickAction() {
return clickAction;
}
public void setClickAction(MethodBinding clickAction) {
this.clickAction = clickAction;
}
public Integer getDblClickDelay() {
ValueBinding vb = getValueBinding("dblClickDelay");
if (vb != null) {
return (Integer) vb.getValue(getFacesContext());
}
if (dblClickDelay != null) {
return dblClickDelay;
}
return new Integer(DEFAULT_DBLCLICK_DELAY);
}
public void setDblClickDelay(Integer dblClickDelay) {
ValueBinding vb = getValueBinding("dblClickDelay");
if (vb != null) {
vb.setValue(getFacesContext(), dblClickDelay);
} else {
this.dblClickDelay = dblClickDelay;
}
}
public Boolean getImmediate() {
if (immediate != null) {
return immediate;
}
ValueBinding vb = getValueBinding("immediate");
if (vb != null) {
return (Boolean) vb.getValue(getFacesContext());
}
// For backwards compatibility, we want RowSelector to continue
// broadcasting RowSelectorEvent in ApplyRequestValues, by default,
// so we don't break existing applications.
return Boolean.TRUE;
}
public void setImmediate(Boolean immediate) {
this.immediate = immediate;
}
public boolean isPreStyleOnSelection() {
if (preStyleOnSelection != null) {
return preStyleOnSelection.booleanValue();
}
ValueBinding vb = getValueBinding("preStyleOnSelection");
if (vb != null) {
Boolean ret = (Boolean) vb.getValue(getFacesContext());
if (ret != null) {
return ret.booleanValue();
}
}
// For backwards compatibility, when a row is (de)selected, we don't
// want to pre-style the row before doing the server round-trip.
return false;
}
public void setPreStyleOnSelection(boolean preStyleOnSelection) {
this.preStyleOnSelection = new Boolean(preStyleOnSelection);
}
public void processDecodes(FacesContext facesContext){
// Check for row selection in its parent table hidden field
HtmlDataTable dataTable = getParentDataTable(this);
String selectedRowsParameter =
TableRenderer.getSelectedRowParameterName(facesContext, dataTable);
Map requestMap = facesContext.getExternalContext()
.getRequestParameterMap();
String selectedRows = (String) requestMap.get(selectedRowsParameter);
boolean isCtrlKey = "true".equals(requestMap.get(selectedRowsParameter+"ctrKy"));
boolean isShiftKey = "true".equals(requestMap.get(selectedRowsParameter+"sftKy"));
String clickedRowParameter = TableRenderer.getClickedRowParameterName(facesContext, dataTable);
String clickCountParameter = TableRenderer.getClickCountParameterName(facesContext, dataTable);
String clickedRowIndex = (String) requestMap.get(clickedRowParameter);
String clickCount = (String) requestMap.get(clickCountParameter);
ClickActionEvent clickActionEvent = null;
RowSelector rowSelector = (RowSelector) this;
boolean skipSelection = false;
if (clickedRowIndex != null && clickCount != null) {
if (clickedRowIndex.trim().length() != 0 && clickCount.trim().length() != 0) {
int rowIndex = dataTable.getRowIndex();
boolean rowClicked = false;
int row = Integer.parseInt(clickedRowIndex);
if (row == rowIndex) {
if (this.getParent() instanceof UIColumns) {
Object servedRow = this.getParent().getAttributes().get("rowServed");
if (servedRow != null) {
if (String.valueOf(servedRow).equals(String.valueOf(rowIndex))) {
return;
}
} else {
this.getParent().getAttributes().put("rowServed", String.valueOf(rowIndex));
}
}
rowClicked = true;
}
try {
if (rowClicked) {
if (rowSelector.getClickListener() != null || rowSelector.getClickAction() != null) {
clickActionEvent = createClickActionEvent(rowSelector, row, Integer.parseInt(clickCount));
}
if (Integer.parseInt(clickCount) == 2 && getValue().booleanValue()) {
skipSelection = true;
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
if (selectedRows == null || selectedRows.trim().length() == 0 || skipSelection) {
// no need to associate with a RowSelectorEvent
if (null != clickActionEvent) {
rowSelector.queueEvent(clickActionEvent);
}
return;
}
Integer oldRow = getClickedRow();
// What row number am I, was I clicked?
int rowIndex = dataTable.getRowIndex();
boolean rowClicked = false;
int row = Integer.parseInt(selectedRows);
if (row == rowIndex) {
if (this.getParent() instanceof UIColumns) {
Object servedRow = this.getParent().getAttributes().get("rowServed");
if (servedRow != null) {
if (String.valueOf(servedRow).equals(String.valueOf(rowIndex))) {
return;
}
} else {
this.getParent().getAttributes().put("rowServed", String.valueOf(rowIndex));
}
}
rowClicked = true;
}
try {
if (rowClicked) {
// Toggle the row selection if multiple
boolean b = rowSelector.getValue().booleanValue();
if (isEnhancedMultiple()) {
if ((!isCtrlKey && !isShiftKey) || isShiftKey ) {
b = true ; //always select
//fix for ICE-5571)
if (!isCtrlKey && !isShiftKey) {
//before selecting any row, first deselect all rows across the page if any
deselectPreviousSelection(dataTable, rowIndex);
} else if (isShiftKey) {
if(!isCtrlKey) {
deselectPreviousSelection(dataTable, rowIndex);
}
int oldIndex = oldRow.intValue();
int currentIndex = rowIndex;
if (oldIndex > rowIndex ) {//backward selection
for (;oldIndex >= currentIndex; currentIndex++) {
dataTable.setRowIndex(currentIndex);
setValue(Boolean.TRUE);
}
} else if (oldIndex < rowIndex) {//forward selection
for (;oldIndex < currentIndex ; oldIndex++) {
dataTable.setRowIndex(oldIndex);
setValue(Boolean.TRUE);
}
}
dataTable.setRowIndex(rowIndex);
}
_queueEvent(rowSelector, rowIndex, b, clickActionEvent);
return;
}
if (isCtrlKey && !isShiftKey) {
b = !b;
_queueEvent(rowSelector, rowIndex, b, clickActionEvent);
return;
}
} else {
b = !b;
_queueEvent(rowSelector, rowIndex, b, clickActionEvent);
// ICE-3440
if (!getMultiple().booleanValue()) {
if (oldRow != null && oldRow.intValue() >= 0 && oldRow.intValue() != rowIndex) {
dataTable.setRowIndex(oldRow.intValue());
if (dataTable.isRowAvailable()) {
setValue(Boolean.FALSE);
}
dataTable.setRowIndex(rowIndex);
}
}
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
private void deselectPreviousSelection(UIData uiData, int rowindex) {
Integer[] selection = new Integer[currentSelection.size()];
currentSelection.toArray(selection);
for (int i=0; iSet the value of the styleClass property.
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/**
* Return the value of the styleClass property.
*/
public String getStyleClass() {
return Util.getQualifiedStyleClass(this,
styleClass,
CSS_DEFAULT.ROW_SELECTION_BASE,
"styleClass");
}
void _queueEvent(RowSelector rowSelector, int rowIndex, boolean isSelected,
ClickActionEvent clickActionEvent) {
rowSelector.setValue(new Boolean(isSelected));
if (isSelected){
selectedRowsList.add(new Integer(rowIndex));
}
RowSelectorEvent evt =
new RowSelectorEvent(rowSelector, rowIndex, isSelected);
if (getImmediate().booleanValue()) {
evt.setPhaseId(PhaseId.APPLY_REQUEST_VALUES);
}
else {
evt.setPhaseId(PhaseId.INVOKE_APPLICATION);
}
rowSelector.queueEvent(evt);
// add reference to RowSelectorEvent
if (null != clickActionEvent) {
clickActionEvent.setRowSelectorEvent(evt);
rowSelector.queueEvent(clickActionEvent);
}
if(rowSelector.getSelectionAction() != null){
RowSelectorActionEvent actevt =
new RowSelectorActionEvent(this);
if (getImmediate().booleanValue()) {
actevt.setPhaseId(PhaseId.APPLY_REQUEST_VALUES);
}
else {
actevt.setPhaseId(PhaseId.INVOKE_APPLICATION);
}
rowSelector.queueEvent(actevt);
}
}
private ClickActionEvent createClickActionEvent(RowSelector rowSelector, int rowIndex, int clickCount) {
ClickActionEvent evt = new ClickActionEvent(rowSelector, rowIndex, clickCount);
if (getImmediate().booleanValue()) {
evt.setPhaseId(PhaseId.APPLY_REQUEST_VALUES);
}
else {
evt.setPhaseId(PhaseId.INVOKE_APPLICATION);
}
return evt;
}
/**
* Set the value of the renderedOnUserRole property.
*/
public void setRenderedOnUserRole(String renderedOnUserRole) {
this.renderedOnUserRole = renderedOnUserRole;
}
/**
* Return the value of the renderedOnUserRole property.
*/
public String getRenderedOnUserRole() {
if (renderedOnUserRole != null) {
return renderedOnUserRole;
}
ValueBinding vb = getValueBinding("renderedOnUserRole");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
/**
* Return the value of the rendered property.
*/
public boolean isRendered() {
if (!Util.isRenderedOnUserRole(this)) {
return false;
}
return super.isRendered();
}
public boolean isKeyboardNavigationEnabled() {
if (keyboardNavigationEnabled != null) {
return keyboardNavigationEnabled.booleanValue();
}
ValueBinding vb = getValueBinding("keyboardNavigationEnabled");
Boolean boolVal = vb != null ?
(Boolean) vb.getValue(getFacesContext()) : null;
return boolVal != null ? boolVal.booleanValue() : true;
}
public void setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled) {
this.keyboardNavigationEnabled = new Boolean(keyboardNavigationEnabled);
}
public boolean isSingleRowAutoSelect() {
if (singleRowAutoSelect != null) {
return singleRowAutoSelect.booleanValue();
}
ValueBinding vb = getValueBinding("singleRowAutoSelect");
Boolean boolVal = vb != null ?
(Boolean) vb.getValue(getFacesContext()) : null;
return boolVal != null ? boolVal.booleanValue() : false;
}
public void setSingleRowAutoSelect(boolean singleRowAutoSelect) {
this.singleRowAutoSelect = new Boolean(singleRowAutoSelect);
}
public void setTabindex(String tabindex) {
this.tabindex = tabindex;
}
public String getTabindex() {
if (tabindex != null) {
return tabindex;
}
ValueBinding vb = getValueBinding("tabindex");
return vb != null ? (String) vb.getValue(getFacesContext()) : null;
}
}