xdev.ui.combobox.CSComboBoxRowConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of csapi Show documentation
XDEV Component Suite
There is a newer version: 6.0.2
package xdev.ui.combobox;

/*-
 * #%L
 * XDEV Component Suite
 * %%
 * Copyright (C) 2011 - 2021 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import javax.swing.ComboBoxModel;
import javax.swing.JComboBox;

import xdev.ui.ItemListOwner;
import xdev.vt.VirtualTable;

import com.jidesoft.combobox.ComboBoxModelWrapperUtils;
import com.jidesoft.grid.QuickFilterField;


/**
 * Component Suite implementation of {@link ComboBoxRowConverter}.
 * 
 * For handling of view modified data for example by filtering or sorting.
 * 
 * 
 * Gets initialized at Component Suite loadtime.
 * 

 * Extends {@link ComboBoxRowConverter} behavior to the ability of reconverting
 * view updates in updated models. For example the ComponentSuite
 * {@link QuickFilterField}s filtering algorithms modify the model-data on model
 * level.
 * 
 * 
 * 
 * @author XDEV Software
 * 
 */
public class CSComboBoxRowConverter extends DefaultComboBoxRowConverter
{
	
	/**
	 * Calculates the data representation of a given view-model row. For example
	 * for saving filtered or sorted data independent to its view index.
	 * 
	 * 
	 *  Use only if the component holds a {@link VirtualTable} as model. 
	 * 
	 * 
	 * @param comboBox
	 *            the comboBox to calculate model modifications from.
	 * @param row
	 *            the view row to get the model representation from.
	 * 
	 * @return the representation of the given row in the datamodel
	 * 
	 */
	@Override
	public int viewToModel(JComboBox comboBox, int row)
	{
		if(comboBox.getModel() instanceof ItemListOwner)
		{
			return super.viewToModel(comboBox,row);
		}
		
		if(row != -1)
		{
			// use Jide functionality to convert from a virtual table model to
			// view index
			int subModelRow = ComboBoxModelWrapperUtils.getActualIndexAt(comboBox.getModel(),row,
					ItemListOwner.class);
			
			if(subModelRow == -1)
			{
				// if no virtual table model is found, use first inner model
				// that is not a table wrapper
				row = super.viewToModel(comboBox,row);
			}
			else
			{
				row = subModelRow;
			}
		}
		return row;
	}
	
	
	/**
	 * Calculates the view representation of a given data-model row. For example
	 * for setting dataindex to to a sorted or filtered component.
	 * 
	 * 
	 *  Use only if the component holds a {@link VirtualTable} as model. 
	 * 
	 * 
	 * @param combobox
	 *            the combobox to calculate model modifications from.
	 * @param row
	 *            the model row to get the view representation from.
	 * 
	 * @return the representation of the given row in the view layer.
	 * 
	 */
	@Override
	public int modelToView(JComboBox combobox, int row)
	{
		// invoke default behavior
		if((combobox.getModel() instanceof ItemListOwner))
		{
			return super.modelToView(combobox,row);
		}
		
		if(row != -1)
		{
			ComboBoxModel outerModel = combobox.getModel();
			ComboBoxModel innerModel = ComboBoxModelWrapperUtils.getActualComboBoxModel(outerModel,
					ItemListOwner.class);
			
			if(innerModel != null && innerModel != outerModel)
			{
				row = ComboBoxModelWrapperUtils.getIndexAt(outerModel,innerModel,row);
			}
			else
			{
				row = ComboBoxModelWrapperUtils.getIndexAt(outerModel,row);
			}
		}
		return row;
	}
}