org.jdal.ui.View Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdal-core Show documentation
JDAL Core Library
The newest version!
/*
 * Copyright 2008-2011 the original author or authors.
 *
 * 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 org.jdal.ui;


import org.jdal.ui.bind.ControlChangeListener;

/**
 * Interface for Views
 * 
 * @author Jose Luis Martin - ([email protected])
 */
public interface View extends Binder{

	/** 
	 * Gets the view name 
	 */
	String getName();
	
	/**
	 * Gets the view Component 
	 */
	Object getPanel();
	
	/**
	 * validate model
	 * @return true if there are not binding errors.
	 */
	boolean validateView();
	
	/**
	 * Get Error Message
	 * @return String with errors
	 */
	String getErrorMessage();
	
	/** 
	 * Reset view state to default values
	 */
	void clear();
	
	/**
	 * Check if user change any controls of view
	 * @return true if any control has changed
	 */
	boolean isDirty();
	
	/**
	 * Enable/Disable All controls
	 */
	void enableView(boolean enabled);
	
	/**
	 * Add a ControlChangeListener to be notified on view changes.
	 * @param listener the ControlChangeListener to add.
	 */
	void addControlChangeListener(ControlChangeListener listener);
	
	/**
	 * Remove a previously added ControlChangeListener
	 * @param listener ControlChangeListener to remove.
	 */
	void removeControlChangeListener(ControlChangeListener listener);
}