org.eclipse.nebula.widgets.nattable.core/src/org/eclipse/nebula/widgets/nattable/core/config/IConfigRegistry.java

/*******************************************************************************
 * Copyright (c) 2012 Original authors and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Original authors and others - initial API and implementation
 ******************************************************************************/
package org.eclipse.nebula.widgets.nattable.core.config;

import java.util.List;

import org.eclipse.nebula.widgets.nattable.core.style.ConfigAttribute;
import org.eclipse.nebula.widgets.nattable.core.style.DisplayMode;
import org.eclipse.nebula.widgets.nattable.core.style.IDisplayModeOrdering;

/**
 * Holds all the settings, bindings and other configuration for a NatTable instance.</br>
 *
 * @see ConfigRegistry
 * @see ConfigRegistryTest for a better understanding
 */
public interface IConfigRegistry {

	/**
	 * If retrieving registered values<br/>
	 * Example 1:<br/>
	 * 	 configRegistry.getConfigAttribute(attribute, DisplayMode.EDIT);<br/>
	 * <ol>
	 * <li>It will look for an attribute registered using the EDIT display mode</li>
	 * <li>If it can't find that it will try and find an attribute under the NORMAL mode</li>
	 * <li>If it can't find one it will try and find one registered without a display mode {@link #registerConfigAttribute(ConfigAttribute, Object)}</li>
	 * </ol>
	 * Example 2:<br/>
	 *   configRegistry.getConfigAttribute(attribute, DisplayMode.NORMAL, "testLabel", "testLabel_1");<br/>
	 * <ol>
	 * <li>It will look for an attribute registered by display mode NORMAL and "testLabel"<li/>
	 * <li>It will look for an attribute registered by display mode NORMAL and "testLabel_1"<li/>
	 * </ol>
	 * @param <T> Type of the attribute
	 * @param configAttribute to be registered
	 * @param targetDisplayMode display mode the cell needs to be in, for this attribute to be returned
	 * @param configLabels the cell needs to have,  for this attribute to be returned
	 * @return the configAttribute, if the display mode and the configLabels match
	 */
	public <T> T getConfigAttribute(ConfigAttribute<T> configAttribute, String targetDisplayMode, String...configLabels);

	/**
	 * @see #getConfigAttribute(ConfigAttribute, String, String...)
	 */
	public <T> T getConfigAttribute(ConfigAttribute<T> configAttribute, String targetDisplayMode, List<String> configLabels);

	/**
	 * @see #getConfigAttribute(ConfigAttribute, String, String...)
	 */
	public <T> T getSpecificConfigAttribute(ConfigAttribute<T> configAttribute, String displayMode, String configLabel);

	/**
	 * Register a configuration attribute
	 * @param configAttribute The {@link ConfigAttribute} to register.
	 * @param attributeValue The value to register for the {@link ConfigAttribute}.
	 */
	public <T> void registerConfigAttribute(ConfigAttribute<T> configAttribute, T attributeValue);

	/**
	 * Register an attribute against a {@link DisplayMode}.
	 * @param configAttribute The {@link ConfigAttribute} to register.
	 * @param attributeValue The value to register for the {@link ConfigAttribute}.
	 * @param targetDisplayMode The {@link DisplayMode} to register the {@link ConfigAttribute} against.
	 */
	public <T> void registerConfigAttribute(ConfigAttribute<T> configAttribute, T attributeValue, String targetDisplayMode);

	/**
	 * Register an attribute against a {@link DisplayMode} and configuration label (applied to cells)
	 * @param configAttribute The {@link ConfigAttribute} to register.
	 * @param attributeValue The value to register for the {@link ConfigAttribute}.
	 * @param targetDisplayMode The {@link DisplayMode} to register the {@link ConfigAttribute} against.
	 * @param configLabel The label to register the {@link ConfigAttribute} against.
	 */
	public <T> void registerConfigAttribute(ConfigAttribute<T> configAttribute, T attributeValue, String targetDisplayMode, String configLabel);

	/**
	 * Unregister the given {@link ConfigAttribute} specified by {@link DisplayMode} and label.
	 * @param configAttributeType The {@link ConfigAttribute} to unregister.
	 * @param displayMode The {@link DisplayMode} against which the {@link ConfigAttribute} is registered.
	 * @param configLabel The label against which the {@link ConfigAttribute} is registered.
	 */
	public <T> void unregisterConfigAttribute(ConfigAttribute<T> configAttributeType, String displayMode, String configLabel);
	
	/**
	 * TODO javadoc
	 * 
	 * @return
	 */
	public IDisplayModeOrdering getDisplayModeOrdering();

}