日期时间选择器控件注释

src/Notes-master/src/net/micode/notes/ui/DateTimePicker.java

@@ -21,92 +21,124 @@ 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;
 
+/**
+ * 日期时间选择器控件，用于选择日期和时间
+ * 支持12小时制和24小时制显示模式
+ */
 public class DateTimePicker extends 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 HOURS_IN_HALF_DAY = 12;  // 半天的小时数
-    private static final int DAYS_IN_ALL_WEEK = 7;
+    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;
+    
+    // 24小时制时间选择器范围
     private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0;
     private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23;
+    
+    // 12小时制时间选择器范围
     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;
+    
+    // AM/PM选择器范围
     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 mDateSpinner;    // 日期选择器
-    private final NumberPicker mMinuteSpinner;
+    private final NumberPicker mHourSpinner;    // 小时选择器
-    private final NumberPicker mAmPmSpinner;
+    private final NumberPicker mMinuteSpinner;  // 分钟选择器
-    private Calendar mDate;
+    private final NumberPicker mAmPmSpinner;   // AM/PM选择器
-
-    private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK];
     
-    private boolean mIsAm;
+    private Calendar mDate;                    // 当前选择的日期时间
     
-    private boolean mIs24HourView;
+    private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK]; // 日期显示值数组
     
-    private boolean mIsEnabled = DEFAULT_ENABLE_STATE;
+    private boolean mIsAm;                     // 是否为上午
+    private boolean mIs24HourView;             // 是否为24小时制
+    private boolean mIsEnabled = DEFAULT_ENABLE_STATE; // 控件是否可用
+    private boolean mInitialising;             // 是否正在初始化
     
-    private boolean mInitialising;
+    private OnDateTimeChangedListener mOnDateTimeChangedListener; // 日期时间变化监听器
-
-    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();
         }
     };
 
+    // 小时变化监听器
     private NumberPicker.OnValueChangeListener mOnHourChangedListener = new NumberPicker.OnValueChangeListener() {
         @Override
         public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
             boolean isDateChanged = false;
             Calendar cal = Calendar.getInstance();
+            
+            // 处理12小时制下的特殊时间点变化
             if (!mIs24HourView) {
+                // 处理PM到AM的日期变化
                 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;
-                } else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) {
+                } 
+                // 处理AM到PM的日期变化
+                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;
                 }
+                
+                // 处理AM/PM切换
                 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();
                 }
-            } else {
+            } 
+            // 处理24小时制下的特殊时间点变化
+            else {
+                // 处理23点到0点的日期变化
                 if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) {
                     cal.setTimeInMillis(mDate.getTimeInMillis());
                     cal.add(Calendar.DAY_OF_YEAR, 1);
                     isDateChanged = true;
-                } else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) {
+                } 
+                // 处理0点到23点的日期变化
+                else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) {
                     cal.setTimeInMillis(mDate.getTimeInMillis());
                     cal.add(Calendar.DAY_OF_YEAR, -1);
                     isDateChanged = true;
                 }
             }
+            
+            // 更新当前小时并触发变化事件
             int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY);
             mDate.set(Calendar.HOUR_OF_DAY, newHour);
             onDateTimeChanged();
+            
+            // 如果需要更新日期
             if (isDateChanged) {
                 setCurrentYear(cal.get(Calendar.YEAR));
                 setCurrentMonth(cal.get(Calendar.MONTH));
@@ -115,21 +147,28 @@ public class DateTimePicker extends FrameLayout {
         }
     };
 
+    // 分钟变化监听器
     private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = new NumberPicker.OnValueChangeListener() {
         @Override
         public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
             int minValue = mMinuteSpinner.getMinValue();
             int maxValue = mMinuteSpinner.getMaxValue();
             int offset = 0;
+            
+            // 处理分钟循环滚动
             if (oldVal == maxValue && newVal == minValue) {
-                offset += 1;
+                offset += 1;  // 从最大值滚动到最小值，小时加1
             } else if (oldVal == minValue && newVal == maxValue) {
-                offset -= 1;
+                offset -= 1;  // 从最小值滚动到最大值，小时减1
             }
+            
+            // 如果需要调整小时
             if (offset != 0) {
                 mDate.add(Calendar.HOUR_OF_DAY, offset);
                 mHourSpinner.setValue(getCurrentHour());
                 updateDateControl();
+                
+                // 更新AM/PM显示
                 int newHour = getCurrentHourOfDay();
                 if (newHour >= HOURS_IN_HALF_DAY) {
                     mIsAm = false;
@@ -139,14 +178,18 @@ public class DateTimePicker extends FrameLayout {
                     updateAmPmControl();
                 }
             }
+            
+            // 设置新分钟并触发变化事件
             mDate.set(Calendar.MINUTE, newVal);
             onDateTimeChanged();
         }
     };
 
+    // AM/PM变化监听器
     private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() {
         @Override
         public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
+            // 切换AM/PM状态并调整时间
             mIsAm = !mIsAm;
             if (mIsAm) {
                 mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY);
@@ -158,39 +201,58 @@ public class DateTimePicker extends FrameLayout {
         }
     };
 
+    /**
+     * 日期时间变化监听接口
+     */
     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));
     }
 
+    /**
+     * 主构造函数，完成所有初始化工作
+     */
     public DateTimePicker(Context context, long date, boolean is24HourView) {
         super(context);
         mDate = Calendar.getInstance();
         mInitialising = true;
-        mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY;
+        mIsAm = getCurrentHourOfDay() < HOURS_IN_HALF_DAY;  // 根据当前时间设置AM/PM
+        
+        // 加载布局
         inflate(context, R.layout.datetime_picker, this);
 
+        // 初始化日期选择器
         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.setOnLongPressUpdateInterval(100);  // 设置长按更新间隔
         mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener);
 
+        // 初始化AM/PM选择器
         String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings();
         mAmPmSpinner = (NumberPicker) findViewById(R.id.amPm);
         mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL);
@@ -198,19 +260,21 @@ public class DateTimePicker extends FrameLayout {
         mAmPmSpinner.setDisplayedValues(stringsForAmPm);
         mAmPmSpinner.setOnValueChangedListener(mOnAmPmChangedListener);
 
-        // update controls to initial state
+        // 更新控件初始状态
         updateDateControl();
         updateHourControl();
         updateAmPmControl();
 
+        // 设置时间显示模式
         set24HourView(is24HourView);
 
-        // set to current time
+        // 设置为当前时间
         setCurrentDate(date);
 
+        // 设置启用状态
         setEnabled(isEnabled());
 
-        // set the content descriptions
+        // 初始化完成
         mInitialising = false;
     }
 
@@ -220,6 +284,7 @@ public class DateTimePicker extends FrameLayout {
             return;
         }
         super.setEnabled(enabled);
+        // 设置各子控件的启用状态
         mDateSpinner.setEnabled(enabled);
         mMinuteSpinner.setEnabled(enabled);
         mHourSpinner.setEnabled(enabled);
@@ -233,18 +298,14 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * 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(long date) {
         Calendar cal = Calendar.getInstance();
@@ -254,13 +315,7 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * 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) {
@@ -272,18 +327,14 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * Get current year
+     * 获取当前年份
-     *
-     * @return The current year
      */
     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()) {
@@ -295,18 +346,14 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * 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 && month == getCurrentMonth()) {
@@ -318,18 +365,14 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * Get current day of the month
+     * 获取当前日期
-     *
-     * @return The day of the month
      */
     public int getCurrentDay() {
         return mDate.get(Calendar.DAY_OF_MONTH);
     }
 
     /**
-     * Set current day of the month
+     * 设置当前日期
-     *
-     * @param dayOfMonth The day of the month
      */
     public void setCurrentDay(int dayOfMonth) {
         if (!mInitialising && dayOfMonth == getCurrentDay()) {
@@ -341,36 +384,38 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * Get current hour in 24 hour mode, in the range (0~23)
+     * 获取当前小时（24小时制）
-     * @return The current hour in 24 hour mode
      */
     public int getCurrentHourOfDay() {
         return mDate.get(Calendar.HOUR_OF_DAY);
     }
 
+    /**
+     * 获取当前小时（根据显示模式）
+     */
     private int getCurrentHour() {
         if (mIs24HourView){
             return getCurrentHourOfDay();
         } else {
             int hour = getCurrentHourOfDay();
             if (hour > HOURS_IN_HALF_DAY) {
-                return hour - HOURS_IN_HALF_DAY;
+                return hour - HOURS_IN_HALF_DAY;  // PM时间转换为12小时制
             } else {
-                return hour == 0 ? HOURS_IN_HALF_DAY : hour;
+                return hour == 0 ? HOURS_IN_HALF_DAY : hour;  // 0点转换为12点
             }
         }
     }
 
     /**
-     * Set current hour in 24 hour mode, in the range (0~23)
+     * 设置当前小时（24小时制）
-     *
-     * @param hourOfDay
      */
     public void setCurrentHour(int hourOfDay) {
         if (!mInitialising && hourOfDay == getCurrentHourOfDay()) {
             return;
         }
         mDate.set(Calendar.HOUR_OF_DAY, hourOfDay);
+        
+        // 处理12小时制下的显示
         if (!mIs24HourView) {
             if (hourOfDay >= HOURS_IN_HALF_DAY) {
                 mIsAm = false;
@@ -390,16 +435,14 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * Get currentMinute
+     * 获取当前分钟
-     *
-     * @return The Current Minute
      */
     public int getCurrentMinute() {
         return mDate.get(Calendar.MINUTE);
     }
 
     /**
-     * Set current minute
+     * 设置当前分钟
      */
     public void setCurrentMinute(int minute) {
         if (!mInitialising && minute == getCurrentMinute()) {
@@ -411,16 +454,14 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * @return true if this is in 24 hour view else false.
+     * 是否为24小时制显示
      */
     public boolean is24HourView() {
         return mIs24HourView;
     }
 
     /**
-     * Set whether in 24 hour or AM/PM mode.
+     * 设置时间显示模式（24小时制或12小时制）
-     *
-     * @param is24HourView True for 24 hour mode. False for AM/PM mode.
      */
     public void set24HourView(boolean is24HourView) {
         if (mIs24HourView == is24HourView) {
@@ -434,20 +475,29 @@ public class DateTimePicker extends FrameLayout {
         updateAmPmControl();
     }
 
+    /**
+     * 更新日期控件显示
+     */
     private void updateDateControl() {
         Calendar cal = Calendar.getInstance();
         cal.setTimeInMillis(mDate.getTimeInMillis());
         cal.add(Calendar.DAY_OF_YEAR, -DAYS_IN_ALL_WEEK / 2 - 1);
         mDateSpinner.setDisplayedValues(null);
+        
+        // 生成一周的日期显示文本
         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);
-        mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2);
+        mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2);  // 设置中间位置为当前日期
         mDateSpinner.invalidate();
     }
 
+    /**
+     * 更新AM/PM控件显示
+     */
     private void updateAmPmControl() {
         if (mIs24HourView) {
             mAmPmSpinner.setVisibility(View.GONE);
@@ -458,6 +508,9 @@ public class DateTimePicker extends FrameLayout {
         }
     }
 
+    /**
+     * 更新小时控件显示范围
+     */
     private void updateHourControl() {
         if (mIs24HourView) {
             mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW);
@@ -469,13 +522,15 @@ public class DateTimePicker extends FrameLayout {
     }
 
     /**
-     * Set the callback that indicates the 'Set' button has been pressed.
+     * 设置日期时间变化监听器
-     * @param callback the callback, if null will do nothing
      */
     public void setOnDateTimeChangedListener(OnDateTimeChangedListener callback) {
         mOnDateTimeChangedListener = callback;
     }
 
+    /**
+     * 触发日期时间变化事件
+     */
     private void onDateTimeChanged() {
         if (mOnDateTimeChangedListener != null) {
             mOnDateTimeChangedListener.onDateTimeChanged(this, getCurrentYear(),