/*******************************************************************************
    * JDateButton: Java Swing Date Button
    * Copyright 2012,2014 Tony Washer
    *
    * 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.
   * ------------------------------------------------------------
   * SubVersion Revision Information:
   * $URL: https://svn.code.sf.net/p/jdatebutton/code/tags/v2.1.0-b3/jdatebutton-swing/src/main/java/net/sourceforge/jdatebutton/swing/JDateButton.java $
   * $Revision: 34 $
   * $Author: tonywasher $
   * $Date: 2015-12-01 16:21:13 +0000 (Tue, 01 Dec 2015) $
   ******************************************************************************/
  package net.sourceforge.jdatebutton.swing;
  
  import java.awt.Dimension;
  import java.awt.Insets;
  import java.awt.Point;
  import java.awt.event.ActionEvent;
  import java.awt.event.ActionListener;
  import java.time.LocalDate;
  import java.util.Locale;
  
  import javax.swing.JButton;
  
  import net.sourceforge.jdatebutton.JDateBaseButton;
  import net.sourceforge.jdatebutton.JDateFormatter;
  
  /**
   * <p>
   * Provides a button which displays the currently selected {@link LocalDate}.
   * <p>
   * When clicked the button displays a mode-less {@link JDateDialog} enabling date selection This
   * dialog will be closed if focus is lost or escape is pressed
   * <p>
   * An underlying {@link JDateConfig} is used to control locale, format and select-able range, and to
   * directly set the selected date. Changes to the selected date are reported via a
   * {@link java.beans.PropertyChangeEvent} for the {@link #PROPERTY_DATE} property, and may be
   * monitored by attaching a {@link java.beans.PropertyChangeListener}
   * @author Tony Washer
   */
  public class JDateButton
          extends JButton
          implements JDateBaseButton {
      /**
       * Serial Id.
       */
      private static final long serialVersionUID = 7110911129423423705L;
  
      /**
       * Name of the Date property.
       */
      public static final String PROPERTY_DATE = "SelectedDate";
  
      /**
       * Preferred Width.
       */
      public static final int PREFERRED_WIDTH = 100;
  
      /**
       * Preferred Height.
       */
      public static final int PREFERRED_HEIGHT = 25;
  
      /**
       * The Underlying Date Configuration.
       */
      private final transient JDateConfig theConfig;
  
      /**
       * The dialog.
       */
      private final JDateDialog theDialog;
  
      /**
       * Constructor.
       */
      public JDateButton() {
          /* Create a button with a standard configuration */
          this(new JDateConfig());
      }
  
      /**
       * Constructor.
       * @param pFormatter the Date formatter
       */
      public JDateButton(final JDateFormatter pFormatter) {
          /* Create a button with a standard configuration */
          this(new JDateConfig(pFormatter));
      }
 
     /**
      * Constructor for extension classes.
      * @param pConfig the configuration to use
      */
     public JDateButton(final JDateConfig pConfig) {
         /* Store configuration and create the Dialog */
         theConfig = pConfig;
 
         /* Create the dialog */
         theDialog = new JDateDialog(this, theConfig);
 
         /* Register this button as the configuration owner */
         theConfig.setOwner(this);
 
         /* Configure the button */
         addActionListener(new ButtonListener());
         setMargin(new Insets(1, 1, 1, 1));
         setPreferredSize(new Dimension(PREFERRED_WIDTH, PREFERRED_HEIGHT));
     }
 
     @Override
     public JDateConfig getDateConfig() {
         return theConfig;
     }
 
     /**
      * Obtain the dialog.
      * @return the dialog
      */
     public JDateDialog getDialog() {
         return theDialog;
     }
 
     /**
      * Obtain SelectedDate.
      * @return the selected date
      */
     public LocalDate getSelectedDate() {
         return theConfig.getSelectedDate();
     }
 
     /**
      * Set SelectedDate.
      * @param pDate the selected date
      */
     public void setSelectedDate(final LocalDate pDate) {
         theConfig.setSelectedDate(pDate);
     }
 
     @Override
     public void setLocale(final Locale pLocale) {
         /* Record the locale */
         theConfig.setLocale(pLocale);
 
         /* Pass the call onwards */
         super.setLocale(pLocale);
     }
 
     /**
      * Set the date format.
      * @param pFormat the format string
      */
     public void setFormat(final String pFormat) {
         theConfig.setFormat(pFormat);
     }
 
     /**
      * Set formatter.
      * @param pFormatter the formatter
      */
     public void setFormatter(final JDateFormatter pFormatter) {
         theConfig.setFormatter(pFormatter);
     }
 
     /**
      * Set the earliest date. This is the earliest date that may be selected. If the configured
      * latest date is earlier than this date, it will be set to this date to ensure a valid range.
      * @param pEarliest the Earliest select-able date (or null if unlimited)
      */
     public void setEarliestDate(final LocalDate pEarliest) {
         theConfig.setEarliestDate(pEarliest);
     }
 
     /**
      * Set the latest date. This is the latest date that may be selected. If the configured earliest
      * date is later than this date, it will be set to this date to ensure a valid range.
      * @param pLatest the Latest select-able date (or null if unlimited)
      */
     public void setLatestDate(final LocalDate pLatest) {
         theConfig.setLatestDate(pLatest);
     }
 
     /**
      * Allow null date selection. If this flag is set an additional button will be displayed
      * allowing the user to explicitly select no date, thus setting the SelectedDate to null.
      * @param pAllowNullDateSelection true/false
      */
     public void setAllowNullDateSelection(final boolean pAllowNullDateSelection) {
         theConfig.setAllowNullDateSelection(pAllowNullDateSelection);
     }
 
     @Override
     public void refreshText() {
         setText(theConfig.formatDate(theConfig.getSelectedDate()));
     }
 
     /**
      * Fire date property change.
      * @param pOldValue the old value
      * @param pNewValue the new value
      */
     protected void fireDatePropertyChange(final LocalDate pOldValue,
                                           final LocalDate pNewValue) {
         /* Fire the property change */
         firePropertyChange(PROPERTY_DATE, pOldValue, pNewValue);
     }
 
     @Override
     public void reBuildNames() {
         theDialog.doBuildNames();
     }
 
     /**
      * Listener class.
      */
     private final class ButtonListener
             implements ActionListener {
         @Override
         public void actionPerformed(final ActionEvent e) {
             /* Position the dialog just below the button */
             Point myLoc = getLocationOnScreen();
             theDialog.setLocation(myLoc.x, myLoc.y
                                            + getHeight());
 
             /* Show the dialog */
             theDialog.setVisible(true);
         }
     }
 }