org.mihalis.opal/src/main/java/org/mihalis/opal/propertyTable/PTWidget.java

/*******************************************************************************
 * Copyright (c) 2012 Laurent CARON
 * 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:
 *     Laurent CARON (laurent.caron at gmail dot com) - initial API and implementation 
 *******************************************************************************/
package org.mihalis.opal.propertyTable;

import org.eclipse.swt.widgets.Composite;

/**
 * Classes which implement this interface are widgets that may compose a
 * PropertyTable (Table for Flat List, TableTree for Category).
 */
public interface PTWidget {

	/**
	 * Build the widget (Table or TreeTable).
	 *
	 * @return the built widget
	 */
	PTWidget build();

	/**
	 * Dispose the previous widget and build a new one (when ones switch from
	 * Category View to Flat List view).
	 *
	 * @param table the PropertyTable to dispose
	 * @return the built widget
	 */
	PTWidget disposeAndBuild(PropertyTable table);

	/**
	 * Inject the parent property table in the widget.
	 *
	 * @param table table to inject
	 */
	void setParentPropertyTable(final PropertyTable table);

	/**
	 * Clear all data and fill the widget.
	 */
	void refillData();

	/**
	 * Gets the widget.
	 *
	 * @return the underlying widget (Table or TableTree)
	 */
	Composite getWidget();

	/**
	 * Update the description panel (if it exists).
	 *
	 * @param selection selected property
	 */
	void updateDescriptionPanel(final Object selection);

}