Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Tentackle - https://tentackle.org.
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
package org.tentackle.fx.table;
import javafx.scene.control.TableColumn;
import javafx.scene.control.TreeItem;
import javafx.scene.control.TreeTableColumn;
import org.tentackle.fx.bind.FxTableBinder;
import org.tentackle.fx.component.FxTableView;
import org.tentackle.fx.component.FxTreeTableView;
import java.util.Collection;
/**
* Configuration for table and treetable views.
* The main purpose is to provide a single object to configure the component.
*
* @param the type of the objects contained within the table's or treetable's items list
* @author harald
*/
public interface TableConfiguration {
/**
* Type of binding.
*/
enum BINDING {
/** no binding. */
NO,
/** standard binding. */
YES,
/** bindable inherited. */
INHERITED
}
/**
* Edit mode.
*/
enum EDITMODE {
/** not editable. */
NO,
/** edit current cell only. */
SIMPLE,
/** edit next/previous cell after commit. */
ROW,
/** edit cell above/below after commit. */
COLUMN
}
/**
* Gets the row object class.
*
* @return the row object class
*/
Class getObjectClass();
/**
* Gets the configurations of the columns.
*
* @return the column configurations
*/
Collection> getColumnConfigurations();
/**
* Gets a column configuration by its name.
*
* @param name the name
* @return the config, null if no such name and displayed name
*/
TableColumnConfiguration getColumnConfiguration(String name);
/**
* Gets a column configuration by its table column.
*
* @param column the table column
* @return the config, null if no such column
*/
TableColumnConfiguration getColumnConfiguration(TableColumn column);
/**
* Gets a column configuration by its treetable column.
*
* @param column the treetable column
* @return the config, null if no such column
*/
TableColumnConfiguration getColumnConfiguration(TreeTableColumn column);
/**
* Gets the name of the table.
* The name is also used as a key to the table preferences.
*
* @return the name, never null
*/
String getName();
/**
* Adds a column via binding path.
*
* @param name the column's binding path
* @param displayedName the displayed column name
* @return the created column configuration
*/
TableColumnConfiguration addColumn(String name, String displayedName);
/**
* Removes a column via binding path.
*
* @param name the column's binding path
* @return the old column configuration, null if no such column
*/
TableColumnConfiguration removeColumn(String name);
/**
* Adds a column configuration.
*
* @param columnConfiguration the config
*/
void addColumnConfiguration(TableColumnConfiguration columnConfiguration);
/**
* Saves the column sizes, visability, view size and sorting to the preferences.
*
* @param table the table
* @param suffix the configuration suffix, null if none
* @param system true if save to system prefs, else user prefs
*/
void savePreferences(FxTableView table, String suffix, boolean system);
/**
* Loads the column sizes, visability, view size and sorting from the preferences.
*
* @param table the table
* @param suffix the configuration suffix, null if none
* @param system true if load from system prefs only, else user prefs first
*/
void loadPreferences(FxTableView table, String suffix, boolean system);
/**
* Saves the column sizes, visability, view size and sorting to the preferences.
*
* @param treeTable the treetable
* @param suffix the configuration suffix, null if none
* @param system true if save to system prefs, else user prefs
*/
void savePreferences(FxTreeTableView treeTable, String suffix, boolean system);
/**
* Loads the column sizes, visability, view size and sorting from the preferences.
*
* @param treeTable the table
* @param suffix the configuration suffix, null if none
* @param system true if load from system prefs only, else user prefs first
*/
void loadPreferences(FxTreeTableView treeTable, String suffix, boolean system);
/**
* Returns whether the preferences include the column sorting.
*
* @return true if sorting is restored from the preferences (default is false)
*/
boolean isSortingIncluded();
/**
* Sets whether the preferences include the column sorting.
*
* @param sortingIncluded true if sorting is restored from the preferences (default is false)
*/
void setSortingIncluded(boolean sortingIncluded);
/**
* Returns whether the preferences include the view size.
*
* @return true if the preferred size is restored from the preferences (default is true)
*/
boolean isViewSizeIncluded();
/**
* Sets whether the preferences include the view size.
*
* @param viewSizeIncluded true if the preferred size is restored from the preferences (default is true)
*/
void setViewSizeIncluded(boolean viewSizeIncluded);
/**
* Gets the type of binding.
*
* @return the binding type
*/
BINDING getBindingType();
/**
* Sets the type of binding.
*
* @param bindingType the binding type
*/
void setBindingType(BINDING bindingType);
/**
* Gets the table binder.
* Don't mix up the table's binder with the FxController's binder!
* The table binder is responsible to bind the cells to the model, whereas the
* controller binder binds the data list to the table.
* As a consequence, binding properties such as the DomainContext, if necessary for cell editors,
* must be applied to the table binder!
*
* @return the binder
*/
FxTableBinder getBinder();
/**
* Returns the edit mode.
*
* @return the edit mode, never null, default is NO
*/
EDITMODE getEditMode();
/**
* Sets the edit mode.
*
* @param editMode the edit mode, null is equivalent to NO
*/
void setEditMode(EDITMODE editMode);
/**
* Configures the table.
*
* @param table the table view
*/
void configure(FxTableView table);
/**
* Configures the treetable.
*
* @param treeTable the treetable view
*/
void configure(FxTreeTableView treeTable);
/**
* Gets the cell type according to the item type.
*
* @param the item type
* @param type the item class
* @return the cell type, never null
*/
TableCellType getTableCellType(Class type);
/**
* Creates a tree item for a treetable.
*
* @param object the object to wrap
* @return the tree item
*/
TreeItem createTreeItem(S object);
}
