org.eclipse.osbp.runtime.web.vaadin.databinding/src/org/eclipse/osbp/runtime/web/vaadin/databinding/properties/IVaadinValueProperty.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * 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:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.runtime.web.vaadin.databinding.properties;

import org.eclipse.core.databinding.property.value.IValueProperty;
import org.eclipse.osbp.runtime.web.vaadin.databinding.values.IVaadinObservableValue;

// TODO: Auto-generated Javadoc
/**
 * {@link IValueProperty} for observing an vaadin Component.
 *
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IVaadinValueProperty extends IValueProperty {

	/**
	 * Returns an observable value observing this value property on the given
	 * property source.
	 * 
	 * @param source
	 *            the property source
	 * @return an observable value observing this value property on the given
	 *         property source
	 */
	IVaadinObservableValue observe(Object source);

	/**
	 * Is used to observe the com.vaadin.data.Property#value attribute.
	 *
	 * @param source
	 *            the source
	 * @return the i vaadin observable value
	 */
	IVaadinObservableValue observeVaadinProperty(Object source);

	/**
	 * Returns an {@link IVaadinObservableValue} observing this value
	 * property on the given Component, which delays notification of value
	 * changes until at least <code>delay</code> milliseconds have elapsed since
	 * that last change event, or until a FocusOut event is received from the
	 * Component (whichever happens first).
	 * <p>
	 * This method is equivalent to
	 * <code>vaadinObservables.observeDelayedValue(delay, observe(Component))</code>.
	 * <p>
	 * Attention: Currently without functionality
	 *
	 * @param delay
	 *            the delay in milliseconds.
	 * @param component
	 *            the component
	 * @return an observable value observing this value property on the given
	 *         Component, and which delays change notifications for
	 *         <code>delay</code> milliseconds.
	 */
	public IVaadinObservableValue observeDelayed(int delay, Object component);

}