io.guise.framework.component.ModalNavigationPanel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation

Guise™ Internet application framework.

There is a newer version: 0.5.3

/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.guise.framework.component;

import static com.globalmentor.java.Classes.*;

/**
 * A panel that supports modal navigation.
 * @param  The type of modal result this modal navigation panel produces.
 * @author Garret Wilson
 */
public interface ModalNavigationPanel extends Panel {

	/** The modal state bound property. */
	public static final String MODAL_PROPERTY = getPropertyName(ModalNavigationPanel.class, "modal");
	/** The result bound property. */
	public static final String RESULT_PROPERTY = getPropertyName(ModalNavigationPanel.class, "result");

	/** @return The result of this navigation panel's modal interaction, or null if no result is given. */
	public R getResult();

	/**
	 * Sets the modal result. This is a bound property that only fires a change event when the new value is different via the equals() method.
	 * @param newResult The new result of this navigation panel's modal interaction, or null if no result is given.
	 * @see #RESULT_PROPERTY
	 */
	public void setResult(final R newResult);

}