/*
 * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
 *
 * 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 net.micode.notes.ui;
 
import java.text.DateFormatSymbols;
import java.util.Calendar;
 
import net.micode.notes.R;
 
 
import android.content.Context;
import android.text.format.DateFormat;
import android.view.View;
import android.widget.FrameLayout;
import android.widget.NumberPicker;
 
public class DateTimePicker extends FrameLayout {
	//FrameLayout是布局模板之一
	//所有的子元素全部在屏幕的右上方
    private static final boolean DEFAULT_ENABLE_STATE = true;
 
    private static final int HOURS_IN_HALF_DAY = 12;
    private static final int HOURS_IN_ALL_DAY = 24;
    private static final int DAYS_IN_ALL_WEEK = 7;
    private static final int DATE_SPINNER_MIN_VAL = 0;
    private static final int DATE_SPINNER_MAX_VAL = DAYS_IN_ALL_WEEK - 1;
    private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0;
    private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23;
    private static final int HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW = 1;
    private static final int HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW = 12;
    private static final int MINUT_SPINNER_MIN_VAL = 0;
    private static final int MINUT_SPINNER_MAX_VAL = 59;
    private static final int AMPM_SPINNER_MIN_VAL = 0;
    private static final int AMPM_SPINNER_MAX_VAL = 1;
    //初始化控件
    private final NumberPicker mDateSpinner;
    private final NumberPicker mHourSpinner;
    private final NumberPicker mMinuteSpinner;
    private final NumberPicker mAmPmSpinner;
    //NumberPicker是数字选择器
    //这里定义的四个变量全部是在设置闹钟时需要选择的变量（如日期、时、分、上午或者下午）
    private Calendar mDate;
    //定义了Calendar类型的变量mDate，用于操作时间
    private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK];
 
    private boolean mIsAm;
 
    private boolean mIs24HourView;
 
    private boolean mIsEnabled = DEFAULT_ENABLE_STATE;
 
    private boolean mInitialising;
 
    private OnDateTimeChangedListener mOnDateTimeChangedListener;
 
    private NumberPicker.OnValueChangeListener mOnDateChangedListener = new NumberPicker.OnValueChangeListener() {
        @Override
        public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
            mDate.add(Calendar.DAY_OF_YEAR, newVal - oldVal);
            updateDateControl();
            onDateTimeChanged();
        }
    };//OnValueChangeListener，这是时间改变监听器，这里主要是对日期的监听
    //将现在日期的值传递给mDate；updateDateControl是同步操作
 
    private NumberPicker.OnValueChangeListener mOnHourChangedListener = new NumberPicker.OnValueChangeListener() {
        //这里是对 小时（Hour） 的监听
    	@Override
        public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
            boolean isDateChanged = false;
            Calendar cal = Calendar.getInstance();
            //声明一个Calendar的变量cal，便于后续的操作
            if (!mIs24HourView) {
                if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) {
                    cal.setTimeInMillis(mDate.getTimeInMillis());
                    cal.add(Calendar.DAY_OF_YEAR, 1);
                    isDateChanged = true;
                    //这里是对于12小时制时，晚上11点和12点交替时对日期的更改
                } else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) {
                    cal.setTimeInMillis(mDate.getTimeInMillis());
                    cal.add(Calendar.DAY_OF_YEAR, -1);
                    isDateChanged = true;
                } 
                //这里是对于12小时制时，凌晨11点和12点交替时对日期的更改
                if (oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY ||
                        oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) {
                    mIsAm = !mIsAm;
                    updateAmPmControl();
                }//这里是对于12小时制时，中午11点和12点交替时对AM和PM的更改
            } else {
                if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) {
                    cal.setTimeInMillis(mDate.getTimeInMillis());
                    cal.add(Calendar.DAY_OF_YEAR, 1);
                    isDateChanged = true;
                    //这里是对于24小时制时，晚上11点和12点交替时对日期的更改
                } else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) {
                    cal.setTimeInMillis(mDate.getTimeInMillis());
                    cal.add(Calendar.DAY_OF_YEAR, -1);
                    isDateChanged = true;
                }
            } //这里是对于12小时制时，凌晨11点和12点交替时对日期的更改
            int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY);
            //通过数字选择器对newHour的赋值
            mDate.set(Calendar.HOUR_OF_DAY, newHour);
            //通过set函数将新的Hour值传给mDate
            onDateTimeChanged();
            if (isDateChanged) {
                setCurrentYear(cal.get(Calendar.YEAR));
                setCurrentMonth(cal.get(Calendar.MONTH));
                setCurrentDay(cal.get(Calendar.DAY_OF_MONTH));
            }
        }
    };
 
    private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = new NumberPicker.OnValueChangeListener() {
        @Override
        //这里是对 分钟（Minute）改变的监听
        public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
            int minValue = mMinuteSpinner.getMinValue();
            int maxValue = mMinuteSpinner.getMaxValue();
            int offset = 0;
            //设置offset，作为小时改变的一个记录数据
            if (oldVal == maxValue && newVal == minValue) {
                offset += 1;
            } else if (oldVal == minValue && newVal == maxValue) {
                offset -= 1;
            }
            //如果原值为59，新值为0，则offset加1
            //如果原值为0，新值为59，则offset减1
            if (offset != 0) {
    // 如果时间偏移量不为零
    	        mDate.add(Calendar.HOUR_OF_DAY, offset);
    // 将日期增加指定的小时数

    	        mHourSpinner.setValue(getCurrentHour());
    // 设置小时的Spinner控件的值为当前小时
    	        updateDateControl();
    // 更新日期控件的显示

    	        int newHour = getCurrentHourOfDay();
    // 获取当前小时数
    	        if (newHour >= HOURS_IN_HALF_DAY) {
        // 如果新的小时数大于等于一天中的半天（12小时）
        		    mIsAm = false;
        // 设置为下午
        		    updateAmPmControl();
        // 更新上午/下午控件
   	            } else {
        // 如果新的小时数小于一天中的半天（12小时）
        		    mIsAm = true;
        // 设置为上午
        		    updateAmPmControl();
        // 更新上午/下午控件
   		        }
	        }

	    mDate.set(Calendar.MINUTE, newVal);
// 设置日期的分钟字段为新值
	    onDateTimeChanged();
// 调用日期时间变更的回调方法
	    };

 
    private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() {
    // 对AM和PM的数值变化进行监听

        @Override
        public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
        // 当数值变化时触发
            mIsAm = !mIsAm;
        // 切换上午/下午标识

            if (mIsAm) {
            // 如果是上午
                mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY);
            // 将时间减去半天（12小时）
            } else {
            // 如果是下午
                mDate.add(Calendar.HOUR_OF_DAY, HOURS_IN_HALF_DAY);
            // 将时间增加半天（12小时）
            }
            updateAmPmControl();
        // 更新上午/下午控件的显示
            onDateTimeChanged();
        // 调用日期时间变更的回调方法
        }
    };

    public interface OnDateTimeChangedListener {
    // 定义日期时间变更监听接口
        void onDateTimeChanged(DateTimePicker view, int year, int month,
                int dayOfMonth, int hourOfDay, int minute);
    // 方法用于回调告知日期时间的变更
    }

 
    public DateTimePicker(Context context) {
        this(context, System.currentTimeMillis());
    }//通过对数据库的访问，获取当前的系统时间
 
    public DateTimePicker(Context context, long date) {
        this(context, date, DateFormat.is24HourFormat(context));
    }//上面函数的得到的是一个天文数字（1970至今的秒数），需要DateFormat将其变得有意义
 
    public DateTimePicker(Context context, long date, boolean is24HourView) {
        super(context);
        //获取系统时间
        mDate = Calendar.getInstance();
        mInitialising = true;
        mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY;
        inflate(context, R.layout.datetime_picker, this);
        //如果当前Activity里用到别的layout，比如对话框layout
        //还要设置这个layout上的其他组件的内容，就必须用inflate()方法先将对话框的layout找出来
        //然后再用findViewById()找到它上面的其它组件
        // 获取日期选择器并设置最小值和最大值
        mDateSpinner = (NumberPicker) findViewById(R.id.date);
        mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL); // 设置最小值
        mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL); // 设置最大值
        mDateSpinner.setOnValueChangedListener(mOnDateChangedListener); // 设置数值变化监听器

// 获取小时选择器并设置数值变化监听器
        mHourSpinner = (NumberPicker) findViewById(R.id.hour);
        mHourSpinner.setOnValueChangedListener(mOnHourChangedListener); // 设置数值变化监听器

// 获取分钟选择器并设置最小值、最大值、长按更新间隔以及数值变化监听器
        mMinuteSpinner = (NumberPicker) findViewById(R.id.minute);
        mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL); // 设置最小值
        mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL); // 设置最大值
        mMinuteSpinner.setOnLongPressUpdateInterval(100); // 设置长按更新间隔
        mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener); // 设置数值变化监听器

// 获取上午/下午选择器并设置最小值、最大值、显示值以及数值变化监听器
        String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings();
        mAmPmSpinner = (NumberPicker) findViewById(R.id.amPm);
        mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL); // 设置最小值
        mAmPmSpinner.setMaxValue(AMPM_SPINNER_MAX_VAL); // 设置最大值
        mAmPmSpinner.setDisplayedValues(stringsForAmPm); // 设置显示值
        mAmPmSpinner.setOnValueChangedListener(mOnAmPmChangedListener); // 设置数值变化监听器

// 更新控件至初始状态
        updateDateControl(); // 更新日期控件
        updateHourControl(); // 更新小时控件
        updateAmPmControl(); // 更新上午/下午控件

        set24HourView(is24HourView); // 设置为24小时制或12小时制

// 设置为当前时间
        setCurrentDate(date); // 设置为指定日期时间

        setEnabled(isEnabled()); // 设置是否可用

// 设置内容描述
        mInitialising = false; // 初始化标志位设为false

    }
 
    @Override
    public void setEnabled(boolean enabled) {
        if (mIsEnabled == enabled) {  // 如果当前状态已经是要设置的状态，无需改变
            return;
        }
        super.setEnabled(enabled);  // 调用父类方法设置整体是否可用

        mDateSpinner.setEnabled(enabled);  // 设置日期选择器是否可用
        mMinuteSpinner.setEnabled(enabled);  // 设置分钟选择器是否可用
        mHourSpinner.setEnabled(enabled);  // 设置小时选择器是否可用
        mAmPmSpinner.setEnabled(enabled);  // 设置上午/下午选择器是否可用

        mIsEnabled = enabled;  // 更新当前状态为设置的状态
    }

    //存在疑问！！！！！！！！！！！！！setEnabled的作用
    //下面的代码通过原程序的注释已经比较清晰，另外可以通过函数名来判断
    //下面的各函数主要是对上面代码引用到的各函数功能的实现
    @Override
    public boolean isEnabled() {
        return mIsEnabled;
    }
 
    /**
     * Get the current date in millis
     *
     * @return the current date in millis
     */
    public long getCurrentDateInTimeMillis() {
        return mDate.getTimeInMillis();
    }//实现函数——得到当前的秒数
 
    /**
     * Set the current date
     *
     * @param date The current date in millis
     */
    public void setCurrentDate(int year, int month,
            int dayOfMonth, int hourOfDay, int minute) {
    // 设置当前日期和时间的年份
        setCurrentYear(year);

    // 设置当前日期和时间的月份
        setCurrentMonth(month);

    // 设置当前日期和时间的日
        setCurrentDay(dayOfMonth);

    // 设置当前日期和时间的小时
        setCurrentHour(hourOfDay);

    // 设置当前日期和时间的分钟
        setCurrentMinute(minute);
    }
//实现函数功能——设置当前的时间，参数是date
 
    /**
     * Set the current date
     *
     * @param year The current year
     * @param month The current month
     * @param dayOfMonth The current dayOfMonth
     * @param hourOfDay The current hourOfDay
     * @param minute The current minute
     */
    public void setCurrentDate(int year, int month,
            int dayOfMonth, int hourOfDay, int minute) {
        setCurrentYear(year);
        setCurrentMonth(month);
        setCurrentDay(dayOfMonth);
        setCurrentHour(hourOfDay);
        setCurrentMinute(minute);
    }//实现函数功能——设置当前的时间，参数是各详细的变量
 
    /**
     * Get current year
     *
     * @return The current year
     */
    //下面是得到year、month、day等值
    public int getCurrentYear() {
        return mDate.get(Calendar.YEAR);
    }
 
    /**
     * Set current year
     *
     * @param year The current year
     */
    public void setCurrentYear(int year) {
    // 如果不是初始化过程，并且传入的年份与当前年份相同，则直接返回，不进行更新
        if (!mInitialising && year == getCurrentYear()) {
            return;
        }

    // 设置日期对象的年份为传入的年份
        mDate.set(Calendar.YEAR, year);

    // 更新日期控件，确保界面显示正确的年份
        updateDateControl();

    // 调用日期时间变化的回调方法，通知相关监听器日期时间已发生改变
        onDateTimeChanged();
    }

 
    /**
     * Get current month in the year
     *
     * @return The current month in the year
     */
    public int getCurrentMonth() {
        return mDate.get(Calendar.MONTH);
    }
 
    /**
     * Set current month in the year
     *
     * @param month The month in the year
     */
    public void setCurrentMonth(int month) {
    // 如果不是初始化过程，并且传入的月份与当前月份相同，则直接返回，不进行更新
        if (!mInitialising &amp;&amp; month == getCurrentMonth()) {
            return;
        }

    // 设置日期对象的月份为传入的月份
        mDate.set(Calendar.MONTH, month);

    // 更新日期控件，确保界面显示正确的月份
        updateDateControl();

    // 调用日期时间变化的回调方法，通知相关监听器日期时间已发生改变
        onDateTimeChanged();
    }

/**
 * 获取当前月份的日期
 *
 * @return 月份中的某一天
 */
    public int getCurrentDay() {
        return mDate.get(Calendar.DAY_OF_MONTH);
    }

/**
 * 设置当前月份的日期
 *
 * @param dayOfMonth 月份中的某一天
 */
    public void setCurrentDay(int dayOfMonth) {
    // 如果不是初始化过程，并且传入的日期与当前日期相同，则直接返回，不进行更新
        if (!mInitialising &amp;&amp; dayOfMonth == getCurrentDay()) {
            return;
        }

    // 设置日期对象的日期为传入的日期
        mDate.set(Calendar.DAY_OF_MONTH, dayOfMonth);

    // 更新日期控件，确保界面显示正确的日期
        updateDateControl();

    // 调用日期时间变化的回调方法，通知相关监听器日期时间已发生改变
        onDateTimeChanged();
    }

/**
 * 获取当前的24小时制小时数，范围为（0~23）
 * @return 当前的24小时制小时数
 */
    public int getCurrentHourOfDay() {
        return mDate.get(Calendar.HOUR_OF_DAY);
    }

/**
 * 获取当前小时数，根据是否为24小时制进行调整
 * @return 当前小时数
 */
    private int getCurrentHour() {
        if (mIs24HourView){
            return getCurrentHourOfDay();
        } else {
            int hour = getCurrentHourOfDay();
            if (hour &gt; HOURS_IN_HALF_DAY) {
                return hour - HOURS_IN_HALF_DAY;
            } else {
                return hour == 0 ? HOURS_IN_HALF_DAY : hour;
            }
        }
    }

//以上是对给定代码的中文注释，每个方法的作用和逻辑都有了解释，有助于理解代码的功能。
 
    /**
     * Set current hour in 24 hour mode, in the range (0~23)
     *
     * @param hourOfDay
     */
    public void setCurrentHour(int hourOfDay) {
    // 如果不是初始化过程，并且传入的小时与当前小时相同，则直接返回，不进行更新
        if (!mInitialising &amp;&amp; hourOfDay == getCurrentHourOfDay()) {
            return;
        }

    // 设置日期对象的小时为传入的小时
        mDate.set(Calendar.HOUR_OF_DAY, hourOfDay);

    // 如果不是24小时制，则根据小时设置上午/下午标志位
        if (!mIs24HourView) {
            if (hourOfDay &gt;= HOURS_IN_HALF_DAY) {
                mIsAm = false;
                if (hourOfDay &gt; HOURS_IN_HALF_DAY) {
                    hourOfDay -= HOURS_IN_HALF_DAY;
                }
            } else {
                mIsAm = true;
                if (hourOfDay == 0) {
                    hourOfDay = HOURS_IN_HALF_DAY;
                }
            }
        // 更新上午/下午控件的显示
            updateAmPmControl();
        }

    // 设置小时控件的值为传入的小时
        mHourSpinner.setValue(hourOfDay);

    // 调用日期时间变化的回调方法，通知相关监听器日期时间已发生改变
        onDateTimeChanged();
    }

/**
 * 获取当前的分钟数
 *
 * @return 当前分钟数
 */
    public int getCurrentMinute() {
        return mDate.get(Calendar.MINUTE);
    }

/**
 * 设置当前的分钟数
 */
    public void setCurrentMinute(int minute) {
    // 如果不是初始化过程，并且传入的分钟与当前分钟相同，则直接返回，不进行更新
        if (!mInitialising &amp;&amp; minute == getCurrentMinute()) {
            return;
        }

    // 设置日期对象的分钟为传入的分钟
        mMinuteSpinner.setValue(minute);
        mDate.set(Calendar.MINUTE, minute);

    // 调用日期时间变化的回调方法，通知相关监听器日期时间已发生改变
        onDateTimeChanged();
    }

/**
 * 判断是否为24小时制
 *
 * @return 如果为24小时制返回true，否则返回false
 */
    public boolean is24HourView () {
        return mIs24HourView;
    }

/**
 * 设置时间显示为24小时制或AM/PM模式
 *
 * @param is24HourView True表示为24小时制，False表示为AM/PM模式
 */
    public void set24HourView(boolean is24HourView) {
    // 如果当前模式与要设置的模式相同，则直接返回，不进行更新
        if (mIs24HourView == is24HourView) {
            return;
        }

    // 更新模式为传入的模式
        mIs24HourView = is24HourView;

    // 根据模式设置上午/下午控件的可见性
        mAmPmSpinner.setVisibility(is24HourView ? View.GONE : View.VISIBLE);

    // 获取当前小时数
        int hour = getCurrentHourOfDay();

    // 更新小时控件的显示
        updateHourControl();

    // 设置当前小时数，以触发小时控件的值改变事件
        setCurrentHour(hour);

    // 更新上午/下午控件的显示
        updateAmPmControl();
    }

 
    // 更新日期控件
    private void updateDateControl() {
        Calendar cal = Calendar.getInstance(); // 创建一个 Calendar 对象
        cal.setTimeInMillis(mDate.getTimeInMillis()); // 用给定的时间设置 Calendar 对象
        cal.add(Calendar.DAY_OF_YEAR, -DAYS_IN_ALL_WEEK / 2 - 1); // 减去一周的一半和一天的时间

        mDateSpinner.setDisplayedValues(null); // 清除日期 Spinner 的显示值
        for (int i = 0; i < DAYS_IN_ALL_WEEK; ++i) { // 循环一周的每一天
            cal.add(Calendar.DAY_OF_YEAR, 1); // 增加一天
            mDateDisplayValues[i] = (String) DateFormat.format("MM.dd EEEE", cal); // 格式化日期并保存在数组中
        }

        mDateSpinner.setDisplayedValues(mDateDisplayValues); // 设置日期 Spinner 的显示值
        mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2); // 设置 Spinner 的初始值为一周的中间位置
        mDateSpinner.invalidate(); // 刷新 Spinner
    }// 对于星期几的算法

// 更新上午/下午控件
    private void updateAmPmControl() {
        if (mIs24HourView) { // 如果是24小时制
            mAmPmSpinner.setVisibility(View.GONE); // 隐藏上午/下午 Spinner
        } else {
            int index = mIsAm ? Calendar.AM : Calendar.PM; // 根据mIsAm确定上午/下午的索引
            mAmPmSpinner.setValue(index); // 设置上午/下午 Spinner 的值为索引所对应的值
            mAmPmSpinner.setVisibility(View.VISIBLE); // 显示上午/下午 Spinner
        }// 对于上下午操作的算法
    }

// 更新小时控件
    private void updateHourControl() {
        if (mIs24HourView) { // 如果是24小时制
            mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW); // 设置小时 Spinner 的最小值
            mHourSpinner.setMaxValue(HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW); // 设置小时 Spinner 的最大值
        } else {
            mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW); // 设置小时 Spinner 的最小值（12小时制）
            mHourSpinner.setMaxValue(HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW); // 设置小时 Spinner 的最大值（12小时制）
        }// 对于小时的算法
    }

/**
 * 设置当点击“设置”按钮时的回调函数
 * @param callback 回调函数，如果为null将不执行任何操作
 */
    public void setOnDateTimeChangedListener(OnDateTimeChangedListener callback) {
        mOnDateTimeChangedListener = callback; // 设置时间变化的监听器
    }

    private void onDateTimeChanged() {
        if (mOnDateTimeChangedListener != null) {
        // 如果监听器不为空，调用监听器的回调函数，传递当前年份、月份、日期、小时和分钟
            mOnDateTimeChangedListener.onDateTimeChanged(this, getCurrentYear(),
                    getCurrentMonth(), getCurrentDay(), getCurrentHourOfDay(), getCurrentMinute());
        }
    }
