• Home
• com.dragome
• dragome-form-bindings
• 0.96-beta2
• source code
• UiCommand.java

×

Project download

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.

com.dragome.forms.bindings.client.command.UiCommand Maven / Gradle / Ivy

package com.dragome.forms.bindings.client.command;

import com.dragome.forms.bindings.client.interceptor.Interceptor;
import com.dragome.forms.bindings.client.value.ValueModel;
import com.dragome.forms.bindings.extra.user.client.Command;

/**
 * A UiCommand is a {@link Command} that also knows it's enabled state and can be bound to buttons.
 * @see #enabled()
 * @see TemporalUiCommand
 * @see AsyncUiCommand
 * @see AbstractUiCommand
 * @see IncrementalUiCommand
 * @see DelegatingUiCommand
 */
public interface UiCommand extends Command
{
	/**
	 * Returns a ValueModel representing the enabled state of this command.
	 * @return a ValueModel representing the enabled state of this command.
	 */
	ValueModel enabled();

	/**
	 * Adds an interceptor to run before the command executes.  The interceptor must invoke
	 * {@link com.pietschy.gwt.pectin.client.interceptor.Invocation#proceed()} or execute {@link com.pietschy.gwt.pectin.client.interceptor.Invocation#getProceedCommand()}
	 * for the execution to proceed.  Failure to do so will effectively abort the execution.  In reality
	 * it's a case of a silent abort since the command is not notified of the interception.
	 * 

	 * As such it it imperative that interceptors be tested to ensure they always execute the proceed
	 * command if they don't want the execution to simple stop without further ado.
	 * 

	 * Of special interest is the case where onNextCall().onXyz(..) has been used and an interceptor
	 * chooses not to proceed.  In this case the events will never be fired.
	 * 

	 * Notes to self:  In order for other parties to be notified of cancellation then the Invocation would need
	 * to provide a cancel or abort method.  The main issue with this is that failing to call it will still abort
	 * the execution.  I.e. abort is equivalent to not calling proceed.  There are a pile of bugs waiting to happen
	 * if I add an Invocation.abort() methods and onAborting(..) style events when I can't guarantee they'll be called.
	 *
	 * @param interceptor the interceptor to add.
	 */
	void interceptUsing(Interceptor interceptor);

	Events always();

	Events onNextCall();
}