org.valkyriercp.dialog.DialogPage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of valkyrie-rcp-core Show documentation
There is a newer version: 1.3
package org.valkyriercp.dialog;

import org.valkyriercp.core.Guarded;
import org.valkyriercp.core.Messagable;
import org.valkyriercp.core.Message;
import org.valkyriercp.core.PropertyChangePublisher;
import org.valkyriercp.factory.ControlFactory;

import javax.swing.*;
import java.awt.*;

/**
 * DialogPages are used to combine several controls in one Dialog which acts as
 * a container. Different implementations are available to create tabs/trees or
 * wizard-like sequences.
 *
 * @author Keith Donald
 */
public interface DialogPage extends ControlFactory, Messagable, Guarded, PropertyChangePublisher {

	public static final String DESCRIPTION_PROPERTY = "description";

	public static final String PAGE_COMPLETE_PROPERTY = "pageComplete";

	/**
	 * Returns this page's name.
	 *
	 * @return the name of this page
	 */
	public String getId();

	/**
	 * Returns this dialog page's title.
	 *
	 * @return the title of this dialog page, or null if none
	 */
	public String getTitle();

	/**
	 * Returns this dialog page's description text.
	 *
	 * @return the description text for this dialog page, or null
	 * if none
	 */
	public String getDescription();

	/**
	 * Returns the current message for this dialog page.
	 *
	 * @return the message, or null if none
	 */
	public Message getMessage();

	/**
	 * Returns this dialog page's image.
	 *
	 * @return the image for this dialog page, or null if none
	 */
	public Image getImage();

	/**
	 * Returns this dialog page's icon.
	 *
	 * @return the icon for this dialog page, or null if none
	 */
	public Icon getIcon();

	/**
	 * Notifies that help has been requested for this dialog page.
	 */
	public void performHelp();

	/**
	 * Sets the visibility of this dialog page.
	 *
	 * @param visible true to make this page visible, and
	 * false to hide it
	 */
	public void setVisible(boolean visible);

	/**
	 * Returns the visibility of this dialog page.
	 *
	 * @return true this page is visible, or false
	 * if this page is hidden
	 */
	public boolean isVisible();

	/**
	 * Returns whether this page is complete or not.
	 * 
	 * This information is typically to decide when it is okay to submit a form.
	 * 
	 *
	 * @return true if this page is complete, and
	 * false otherwise
	 */
	public boolean isPageComplete();

}