Changeset 35606

Timestamp:

10/14/09 03:19:59 (4 years ago)

Author:

tarchan

Message:

lang/java/DesktopKit: javadocを整理

Location:

lang/java/DesktopKit/trunk/src/com/mac/tarchan/desktop

Files:

• FileAttachPanel.java (modified) (1 diff)
• SexyControl.java (modified) (46 diffs)

lang/java/DesktopKit/trunk/src/com/mac/tarchan/desktop/FileAttachPanel.java

@@ -161 +161 @@
         public String toString()
         {
-                return attachFile != null ? attachFile.getAbsolutePath() : null;
+                return attachFile != null ? attachFile.getAbsolutePath() : "";
         }
 }

lang/java/DesktopKit/trunk/src/com/mac/tarchan/desktop/SexyControl.java

@@ -141 +141 @@
                  */
                 segmentedTextured,
-//              /** segmentedGradient */
-//              segmentedGradient,
+                /**
+                 * segmentedGradient
+                 * 
+                 * @see <a href="http://lists.apple.com/archives/Java-dev/2008/May/msg00400.html">Re: + / - Buttons</a>
+                 */
+                segmentedGradient,
         }
 
@@ -195 +199 @@
         /**
          * JComboBox.isPopDown
+         * 
+         * <pre>
          * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Applies to: {@link JComboBox}
          * This property alters the JComboBox's style to specify if it is intended to be a pop-down or a pop-up control. 
+         * </pre>
          */
         public static final String JComboBoxIsPopDownKey = "JComboBox.isPopDown";
@@ -204 +211 @@
         /**
          * JComboBox.isSquare
+         * 
+         * <pre>
          * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Applies to: {@link JComboBox}
          * This property changes the appearance of a JComboBox to have squared off edges.
+         * </pre>
          */
         public static final String JComboBoxIsSquareKey = "JComboBox.isSquare";
@@ -213 +223 @@
         /**
          * JProgressBar.style
+         * 
+         * @see JProgressBarStyle
+         */
+        public static final String JProgressBarStyleKey = "JProgressBar.style";
+
+        /**
+         * JProgressBar.style
+         * 
+         * <pre>
          * Type: {@link String}
          * Allowed Values: "circular"
          * Applies to: {@link JProgressBar}
          * This proper changes any indeterminate JProgressBar into a small circular spinning indeterminate progress indicator.
-         * 
-         * @see JProgressBarStyle
-         */
-        public static final String JProgressBarStyleKey = "JProgressBar.style";
-
-        /** JProgressBar.style */
+         * </pre>
+         */
         public enum JProgressBarStyle
         {
@@ -233 +248 @@
         /**
          * JTableHeader.selectedColumn
+         * 
+         * <pre>
          * Type: {@link Number}
          * Applies to: {@link JTableHeader}
          * This property allows you to highlight the currently selected column of a JTable.
          * The value should be set to the index of the column in the data model that you wish to be selected.
+         * </pre>
          */
         public static final String JTableHeaderSelectedColumnKey = "JTableHeader.selectedColumn";
@@ -242 +260 @@
         /**
          * JTableHeader.sortDirection
+         * 
+         * @see JTableHeaderSortDirection
+         */
+        public static final String JTableHeaderSortDirectionKey = "JTableHeader.sortDirection";
+
+        /**
+         * JTableHeader.sortDirection
+         * 
+         * <pre>
          * Type: {@link String}
          * Allowed Values: "ascending", "decending", null
@@ -250 +277 @@
          * <b>Note:</b> The incorrect spelling "decending" for this properties allowed values is correct.
          * Using the correctly spelled "descending" will have no effect in J2SE 5.0 on Mac OS X 10.5.0
-         * 
-         * @see JTableHeaderSortDirection
-         */
-        public static final String JTableHeaderSortDirectionKey = "JTableHeader.sortDirection";
-
-        /** JTableHeader.sortDirection */
+         * </pre>
+         */
         public enum JTableHeaderSortDirection
         {
@@ -266 +289 @@
         /**
          * JTextField.variant
+         * 
+         * @see JTextFieldVariant
+         */
+        public static final String JTextFieldVariantKey = "JTextField.variant";
+
+        /**
+         * JTextField.variant
+         * 
+         * <pre>
          * Type: {@link String}
          * Allowed Values: "search"
@@ -271 +303 @@
          * This property changes the text field into a search field.
          * For additional functionality see the optional JTextField.Search.FindPopup, JTextField.Search.FindAction and JTextField.Search.CancelAction properties.
-         * 
-         * @see JTextFieldVariant
-         */
-        public static final String JTextFieldVariantKey = "JTextField.variant";
-
-        /** JTextField.variant */
+         * </pre>
+         */
         public enum JTextFieldVariant
         {
@@ -287 +315 @@
         /**
          * JTextField.Search.FindPopup
+         * 
+         * <pre>
          * Type: {@link JPopupMenu}
          * Allowed Values: Any JPopupMenu
@@ -292 +322 @@
          * Setting this property attaches the provided JPopupMenu to the search control, and alters the icon to represent that there is a popup menu.
          * Requires the JTextField.variant to be set to "search".
+         * </pre>
          */
         public static final String JTextFieldSearchFindPopupKey = "JTextField.Search.FindPopup";
@@ -297 +328 @@
         /**
          * JTextField.Search.FindAction
+         * 
+         * <pre>
          * Type: {@link ActionListener}
          * Allowed Values: Any ActionListener
@@ -302 +335 @@
          * Setting this property will trigger the provided ActionListener when the "find icon" in the search field is clicked.
          * Requires the JTextField.variant to be set to "search".
+         * </pre>
          */
         public static final String JTextFieldSearchFindActionKey = "JTextField.Search.FindAction";
@@ -307 +341 @@
         /**
          * JTextField.Search.CancelAction
+         * 
+         * <pre>
          * Type: {@link ActionListener}
          * Allowed Values: Any ActionListener
@@ -313 +349 @@
          * Requires the JTextField.variant to be set to "search".
          * <b>Note:</b> The cancel icon is only present when there is text in the search field.
+         * </pre>
          */
         public static final String JTextFieldSearchCancelActionKey = "JTextField.Search.CancelAction";
@@ -318 +355 @@
         /**
          * Window.documentModified
-         * Type: Boolean
+         * 
+         * <pre>
+         * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Default Value: Boolean.FALSE
@@ -324 +363 @@
          * This property adds the document dirty mark in the close button of the window.
          * This is used to indicate that the document window has unsaved content, and attempts to close the window will request that the user save the document or discard changes.
+         * </pre>
          */
         public static final String WindowDocumentModifiedKey = "Window.documentModified";
@@ -329 +369 @@
         /**
          * Window.documentFile
+         * 
+         * <pre>
          * Type: {@link java.io.File}
          * Allowed Values: Any
@@ -334 +376 @@
          * This property adds a document proxy icon to the title bar of the window.
          * <b>WARNING:</b> This property only applies to JRootPanes that have a heavyweight peer.
+         * </pre>
          */
         public static final String WindowDocumentFileKey = "Window.documentFile";
@@ -339 +382 @@
         /**
          * Window.style
-         * Type: String
+         * 
+         * @see WindowStyle
+         */
+        public static final String WindowStyleKey = "Window.style";
+
+        /**
+         * Window.style
+         * 
+         * <pre>
+         * Type: {@link String}
          * Allowed Values: "small"
          * Applies to: JRootPane
@@ -347 +399 @@
          * This is similar to how native applications behave.
          * <b>WARNING:</b> This property must be set before the heavyweight peer for the Window is created. Once addNotify() has been called on the component, causing creation of the heavyweight peer, changing this property has no effect.
-         * 
-         * @see WindowStyle
-         */
-        public static final String WindowStyleKey = "Window.style";
-
-        /** Window.style */
+         * </pre>
+         */
         public enum WindowStyle
         {
@@ -361 +409 @@
         /**
          * Window.alpha
+         * 
+         * <pre>
          * Type: {@link Float}
          * Allowed Values: Any value from 0.0 to 1.0 inclusive
@@ -367 +417 @@
          * This property sets the opacity for the whole window and can be changed throughout the lifetime of the window.
          * <b>WARNING:</b> This property only applies to JRootPanes that have a heavyweight peer.
+         * </pre>
          */
         public static final String WindowAlphaKey = "Window.alpha";
@@ -372 +423 @@
         /**
          * Window.shadow
-         * Type: Boolean
+         * 
+         * <pre>
+         * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Default Value: Boolean.TRUE
@@ -379 +432 @@
          * <b>WARNING:</b> This property must be set before the heavyweight peer for the Window is created.
          * Once addNotify() has been called on the component, causing creation of the heavyweight peer, changing this property has no effect.
+         * </pre>
          */
         public static final String WindowShadowKey = "Window.shadow";
@@ -384 +438 @@
         /**
          * apple.awt.windowShadow.revalidateNow
-         * Type: Object
+         * 
+         * <pre>
+         * Type: {@link Object}
          * Allowed Values: Any
          * Applies to JRootPane
@@ -392 +448 @@
          * <b>WARNING:</b> This property only applies to JRootPanes that have a heavyweight peer.
          * <b>IMPORTANT:</b> This property requires the Window.shadow property to be explicitly set to Boolean.TRUE
+         * </pre>
          */
         public static final String AppleAwtWindowShadowRrevalidateNowKey = "apple.awt.windowShadow.revalidateNow";
@@ -397 +454 @@
         /**
          * apple.awt.brushMetalLook
-         * Type: Boolean
+         * 
+         * <pre>
+         * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Default Value: Undefined
@@ -404 +463 @@
          * This client property overrides the corresponding system property, which determines its default value.
          * <b>WARNING:</b> This property must be set before the heavyweight peer for the Window is created. Once addNotify() has been called on the component, causing creation of the heavyweight peer, changing this property has no effect.
+         * </pre>
          */
         public static final String AppleAwtBrushMetalLookKey = "apple.awt.brushMetalLook";
@@ -409 +469 @@
         /**
          * apple.awt.draggableWindowBackground
-         * Type: Boolean
+         * 
+         * <pre>
+         * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Default Value: Boolean.FALSE
@@ -417 +479 @@
          * <b>WARNING:</b> This property must be set before the heavyweight peer for the Window is created.
          * Once addNotify() has been called on the component, causing creation of the heavyweight peer, changing this property has no effect.
+         * </pre>
          */
         public static final String AppleAwtDraggableWindowBackgroundKey = "apple.awt.draggableWindowBackground";
@@ -422 +485 @@
         /**
          * apple.awt.delayWindowOrdering
-         * Type: Boolean
+         * 
+         * <pre>
+         * Type: {@link Boolean}
          * Allowed Values: Boolean.TRUE, Boolean.FALSE
          * Default Value: Boolean.FALSE
@@ -431 +496 @@
          * <b>WARNING:</b> This property must be set before the heavyweight peer for the Window is created.
          * Once addNotify() has been called on the component, causing creation of the heavyweight peer, changing this property has no effect.
+         * </pre>
          */
         public static final String AppleAwtDelayWindowOrderingKey = "apple.awt.delayWindowOrdering";
@@ -486 +552 @@
          * @param group ボタングループ
          * @param style スタイル
+         * @see #setSegmentButtonStyle(AbstractButton, JButtonButtonType, JButtonSegmentPosition)
          */
         public static void setSegmentButtonStyle(ButtonGroup group, JButtonButtonType style)
@@ -532 +599 @@
          * @param find 検索アクション
          * @param cancel キャンセルアクション
+         * @see #JTextFieldVariantKey
+         * @see #JTextFieldSearchFindPopupKey
+         * @see #JTextFieldSearchFindActionKey
+         * @see #JTextFieldSearchCancelActionKey
          */
         public static void setSearchTextField(JTextField textField, JPopupMenu popupMenu, ActionListener find, ActionListener cancel)
@@ -545 +616 @@
          * 
          * @param progressBar プログレスバー
+         * @see JProgressBarStyle#circular
          */
         public static void setCircularProgressBar(JProgressBar progressBar)
@@ -556 +628 @@
          * 
          * @param comboBox コンボボックス
+         * @see #JComboBoxIsPopDownKey
          */
         public static void setPopDownComboBox(JComboBox comboBox)
@@ -566 +639 @@
          * 
          * @param comboBox コンボボックス
+         * @see #JComboBoxIsSquareKey
          */
         public static void setSquareComboBox(JComboBox comboBox)
@@ -577 +651 @@
          * @param window ウインドウ
          * @param modified ドキュメント変更
+         * @see #WindowDocumentModifiedKey
          */
         public static void setWindowDocumentModified(RootPaneContainer window, boolean modified)
@@ -590 +665 @@
          * @param window ウインドウ
          * @param file ファイル
+         * @see #WindowDocumentFileKey
          */
         public static void setWindowDocumentFile(RootPaneContainer window, File file)
@@ -603 +679 @@
          * @param window ウインドウ
          * @param style スタイル
+         * @see #WindowStyleKey
          */
         public static void setWindowStyle(RootPaneContainer window, WindowStyle style)
@@ -616 +693 @@
          * @param window ウインドウ
          * @param alpha Any value from 0.0 to 1.0 inclusive
+         * @see #WindowAlphaKey
          */
         public static void setWindowAlpha(RootPaneContainer window, double alpha)
@@ -628 +706 @@
          * @param window ウインドウ
          * @param shadow シャドウ
+         * @see #WindowShadowKey
          */
         public static void setWindowShadow(RootPaneContainer window, boolean shadow)
@@ -636 +715 @@
 
         /**
-         * 
+         * useBrushMetalLook
+         * 
+         * @see #AppleAwtBrushMetalLookKey
          */
         public static void useBrushMetalLook()
@@ -645 +726 @@
         /**
          * メニューバーをスクリーンに設定します。
+         * 
+         * @see #AppleLafUseScreenMenuBarKey
          */
         public static void useScreenMenuBar()
@@ -655 +738 @@
          * 
          * @param aboutName アプリケーション名
+         * @see #AppleMenuAboutNameKey
          */
         public static void setAppleMenuAboutName(String aboutName)