MultiSelectColumnDescriptor.java

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.  
* <p>
*/

package org.olat.core.gui.components.table;

import org.olat.core.gui.render.Renderer;
import org.olat.core.gui.render.StringOutput;
import org.olat.core.gui.translator.Translator;

class MultiSelectColumnDescriptor implements ColumnDescriptor {

	private static final String DOUBLE_QUOTE = "\"";
	private static final String VALUE = "\" value=\"";
	private static final String CLOSE_HTML_TAG = " />";
	Table table;
	
	MultiSelectColumnDescriptor(){
		//package visibility for constructor
	}

	@Override
	public int getDataColumn() {
		return -1;
	}

	@Override
	public void renderValue(final StringOutput sb, final int row, final Renderer renderer) {
		// add checkbox
		int currentPosInModel = table.getSortedRow(row);
		if (renderer == null) {
			// render for export
			if (table.getMultiSelectSelectedRows().get(currentPosInModel)) {
				sb.append("x");
			}
		} else {
			boolean checked = table.getMultiSelectSelectedRows().get(currentPosInModel);
			boolean readonly = table.getMultiSelectReadonlyRows().get(currentPosInModel) || table.isMultiSelectAsDisabled();
			sb.append("<input type=\"checkbox\" name=\"" + TableRenderer.TABLE_MULTISELECT_GROUP + VALUE).append(currentPosInModel).append(DOUBLE_QUOTE);
			if (checked){
				sb.append(" checked=\"checked\"");
			}
			if (readonly){
				sb.append(" readonly=\"readonly\" disabled=\"disabled\"");
			}
			sb.append(CLOSE_HTML_TAG);
			// workaround: value of disabled checkboxes will not be returned on submit
			if (readonly & checked) {
				sb.append("<input type=\"hidden\" name=\"" + TableRenderer.TABLE_MULTISELECT_GROUP + VALUE).append(currentPosInModel).append(DOUBLE_QUOTE);
				sb.append(CLOSE_HTML_TAG);
			}
		}
	}

	@Override
	public int compareTo(final int rowa, final int rowb) {
		boolean rowaChecked = table.getMultiSelectSelectedRows().get(rowa);
		boolean rowbChecked = table.getMultiSelectSelectedRows().get(rowb);
		if (rowaChecked && !rowbChecked){
			return -1;
		} else if (!rowaChecked && rowbChecked){
			return 1;
		}
		return 0;
	}

	@Override
	public boolean equals(final Object object) {
		if(this == object){
			return true;
		}
		if(object == null){
			return false;
		}
		if (getClass() != object.getClass()){
			return false;
		}
		if(getClass() != (object.getClass()) ){
			return false;
		}
		
		MultiSelectColumnDescriptor other = (MultiSelectColumnDescriptor)object;
		return other.table == table;

	}
	
	@Override
	public int hashCode() {
		if(table == null){
			return 1;
		}else{
			return table.hashCode();
		}
	}
	
	public String getHeaderKey() {
		// render as checkbox icon to minimize used space for header
		Translator trans = (table != null ? table.getTranslator() : null);		
		String choice = (trans != null ? trans.translate("table.header.multiselect") : "");
		return "<i class='o_icon o_icon_checkbox_checked o_icon-lg' title=\"" + choice + "\"> </i>";
	}
	
	public boolean translateHeaderKey() {
		return false;
	}

	public int getAlignment() {
		return ColumnDescriptor.ALIGNMENT_LEFT;
	}

	public String getAction(final int row) {
		return null;
	}

	public String getPopUpWindowAttributes() {
		return null;
	}

	public boolean isPopUpWindowAction() {
		return false;
	}

	public boolean isSortingAllowed() {
		return true;
	}

	public void modelChanged() {
		// nothing to do here
	}

	public void otherColumnDescriptorSorted() {
		// nothing to do here
	}

	public void setTable(final Table table) {
		this.table = table;
	}

	public void sortingAboutToStart() {
		// nothing to do here
	}

	public String toString(final int rowid) {
		return table.getMultiSelectSelectedRows().get(rowid) ? "checked" : "unchecked";
	}

}