xdev.ui.DateFormularComponent Maven / Gradle / Ivy

Go to download
/*
 * XDEV Application Framework - XDEV Application Framework
 * Copyright © 2003 XDEV Software (https://xdev.software)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package xdev.ui;


import javax.swing.JComponent;

import xdev.ui.text.TextFormat;
import xdev.util.DateFormatException;
import xdev.util.XdevDate;


/**
 * An extended {@link FormularComponent} which can edit and display dates.
 * 
 * @author XDEV Software
 * 
 * @param 
 *            type of the implementing {@link JComponent}
 * 
 * @since 3.1
 */
public interface DateFormularComponent extends FormularComponent
{
	/**
	 * Returns the value of this {@link DateFormularComponent} as
	 * {@link XdevDate}.
	 * 
	 * @return the value of this {@link DateFormularComponent} as
	 *         {@link XdevDate}.
	 * 
	 * @throws DateFormatException
	 *             if the value of this {@link DateFormularComponent} can not be
	 *             converted.
	 * 
	 * @see #getDate(XdevDate)
	 * @see TextFormat#parseDate(String)
	 */
	public XdevDate getDate() throws DateFormatException;
	

	/**
	 * Returns the value of this {@link DateFormularComponent} as
	 * {@link XdevDate}. If the internal value can not be converted into a
	 * {@link XdevDate}, the defaultValue is returned.
	 * 
	 * @param defaultValue
	 *            the default {@link XdevDate}
	 * 
	 * @return the value of this {@link DateFormularComponent}. If the internal
	 *         value can not be converted into a {@link XdevDate}, the
	 *         defaultValue is returned.
	 * 
	 * @see #getDate()
	 */
	public XdevDate getDate(XdevDate defaultValue);
	

	/**
	 * Sets the date of this {@link DateFormularComponent}.
	 * 
	 * @param date
	 *            the new date
	 */
	public void setDate(XdevDate date);
}