xdev.ui.ganttchart.template.SplitableComponent 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.ganttchart.template;

/*-
 * #%L
 * XDEV BI 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 com.jidesoft.gantt.GanttChartPane;


/**
 * Component which defines the ability to detach parts of itself.
 * 
 * @since 4.0
 * @author XDEV Software jwill
 */
public interface SplitableComponent
{
	/**
	 * Sets the {@link ComponentSplitHandler} that understands to split the
	 * {@link GanttChartPane}s UI.
	 * 
	 * A common use case would be for example the seperation of the
	 * TreeTable from the GanttChart
	 * 
	 * 
	 * @param splitHandler
	 *            the split handler to use.
	 */
	public void setComponentSplitHandler(ComponentSplitHandler splitHandler);
	
	
	/**
	 * Returns the {@link ComponentSplitHandler} that understands to split the
	 * {@link GanttChartPane}s UI.
	 * 
	 * @return the splitHandler which is currently used.
	 */
	public ComponentSplitHandler getComponentSplitHandler();
}