xdev.ui.ganttchart.template.RelationalGanttTemplate 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 xdev.ui.ganttchart.UpdateableGanttEntry;
import xdev.ui.ganttchart.action.GanttEntryRelationManager;
import xdev.ui.ganttchart.model.GanttRelationPersistence;

import com.jidesoft.gantt.GanttChart;
import com.jidesoft.gantt.GanttEntry;
import com.jidesoft.gantt.GanttEntryRelation;


/**
 * {@link RelationalGanttTemplate} provides a summarized and simplified way to
 * use a {@link GanttChart} implicated with persistence features.
 * 
 * Also prepares the possibility to create relations between
 * gantt entries.
 * 
 * 
 * 
 * Including convertible:
 * 

 *  {@link GanttChartTemplateTablePopup}
 *  {@link ComponentSplitHandler}
 *  {@link GanttEntryEditor}/creator
 * 
 * 
 * 
 * 
 * Additionally enables the user to create and validate
 * {@link GanttEntryRelation}s.
 * 
 * 
 * @param 
 *            the customized {@link GanttEntry} type. .
 * 
 * @param 
 *            the gantt data type, for example Date or
 *            Integer. Has to extend {@link Comparable} for
 *            validation purpose.
 *            
 *            Used for entry scaling via {@link GanttEntry#getRange()}
 *            
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public interface RelationalGanttTemplate> extends
		GanttTemplate, GanttEntryRelationManager
{
	public static final String	PROPERTY_RELATION_ENABLED	= "relationsEnabled";
	
	
	public void setGanttRelationPersistence(GanttRelationPersistence relationPersistence);
	
	
	public GanttRelationPersistence getGanttRelationPersistence();
	
	
	/**
	 * Predicates whether the relation validation is enabled or not.
	 * 
	 * @return the relation validation flag.
	 */
	public boolean isRelationValidation();
	
	
	/**
	 * Enables validation of upcoming {@link GanttEntryRelation}s.
	 * 
	 * @param relationInteraction
	 *            the relation validation flag to set.
	 */
	public void setRelationValidation(boolean relationInteraction);
}