/**
 *    FunctionSetting.java
 *    Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.expeditee.setting;

import org.expeditee.gui.AttributeValuePair;
import org.expeditee.items.Text;

public abstract class FunctionSetting extends Setting {
	
	public FunctionSetting(String tooltip, String name) {
		super(tooltip, name);
	}
	
	/**
	 * The code to run
	 * Must be overridden
	 */
	protected abstract void run();
	
	/**
	 * runs the setting specific code if the text item has a value of true
	 */
	public boolean setSetting(Text text) {
		AttributeValuePair avp = new AttributeValuePair(text.getText(), false);
		if(avp.getValue() != null && avp.getValue().trim().length() != 0 && avp.getBooleanValue()) {
			run();
			return true;
		}
		return false;
	}
	
	@Override
	public Text generateRepresentation(String label, String frameset) {
		Text text = new Text(label + ": false");
		return text;
	}
}