You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by rw...@apache.org on 2016/05/24 18:17:48 UTC
svn commit: r1745388 - /pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/
Author: rwhitcomb
Date: Tue May 24 18:17:47 2016
New Revision: 1745388
URL: http://svn.apache.org/viewvc?rev=1745388&view=rev
Log:
PIVOT-976: More Javadoc fixes for the warnings from Java 8.
Continuing on down the list, to finish off the WTK skin classes.
Most of the changes were missing @return or @param values.
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BorderSkin.java Tue May 24 18:17:47 2016
@@ -316,14 +316,16 @@ public class BorderSkin extends Containe
}
/**
- * Returns the font used in rendering the title
+ * @return The font used in rendering the title.
*/
public Font getFont() {
return font;
}
/**
- * Sets the font used in rendering the title
+ * Sets the font used in rendering the title.
+ *
+ * @param font The new font to use for the border title.
*/
public void setFont(Font font) {
if (font == null) {
@@ -335,9 +337,9 @@ public class BorderSkin extends Containe
}
/**
- * Sets the font used in rendering the title
+ * Sets the font used in rendering the title.
*
- * @param font A {@link ComponentSkin#decodeFont(String) font specification}
+ * @param font A {@linkplain ComponentSkin#decodeFont(String) font specification}.
*/
public final void setFont(String font) {
if (font == null) {
@@ -348,9 +350,9 @@ public class BorderSkin extends Containe
}
/**
- * Sets the font used in rendering the title
+ * Sets the font used in rendering the title.
*
- * @param font A dictionary {@link Theme#deriveFont describing a font}
+ * @param font A dictionary {@linkplain Theme#deriveFont describing a font}.
*/
public final void setFont(Dictionary<String, ?> font) {
if (font == null) {
@@ -361,14 +363,16 @@ public class BorderSkin extends Containe
}
/**
- * Returns the color of the border
+ * @return The color of the border.
*/
public Color getColor() {
return color;
}
/**
- * Sets the color of the border
+ * Sets the color of the border.
+ *
+ * @param color The new color for the border.
*/
public void setColor(Color color) {
if (color == null) {
@@ -380,7 +384,7 @@ public class BorderSkin extends Containe
}
/**
- * Sets the color of the border
+ * Sets the color of the border.
*
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
@@ -415,14 +419,16 @@ public class BorderSkin extends Containe
}
/**
- * Returns the thickness of the border
+ * @return The thickness of the border.
*/
public int getThickness() {
return thickness;
}
/**
- * Sets the thickness of the border
+ * Sets the thickness of the border.
+ *
+ * @param thickness The border thickness (in pixels).
*/
public void setThickness(int thickness) {
if (thickness < 0) {
@@ -434,7 +440,9 @@ public class BorderSkin extends Containe
}
/**
- * Sets the thickness of the border
+ * Sets the thickness of the border.
+ *
+ * @param thickness The border thickness (integer value in pixels).
*/
public void setThickness(Number thickness) {
if (thickness == null) {
@@ -445,7 +453,7 @@ public class BorderSkin extends Containe
}
/**
- * Returns the amount of space between the edge of the Border and its
+ * @return The amount of space between the edge of the Border and its
* content.
*/
public Insets getPadding() {
@@ -455,6 +463,8 @@ public class BorderSkin extends Containe
/**
* Sets the amount of space to leave between the edge of the Border and its
* content.
+ *
+ * @param padding The set of padding values.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -483,6 +493,8 @@ public class BorderSkin extends Containe
/**
* Sets the amount of space to leave between the edge of the Border and its
* content, uniformly on all four edges.
+ *
+ * @param padding The padding value (in pixels) to use for all four sides.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -491,6 +503,8 @@ public class BorderSkin extends Containe
/**
* Sets the amount of space to leave between the edge of the Border and its
* content, uniformly on all four edges.
+ *
+ * @param padding The padding value (integer value in pixels) to use for all four sides.
*/
public void setPadding(Number padding) {
if (padding == null) {
@@ -516,7 +530,7 @@ public class BorderSkin extends Containe
}
/**
- * Returns a {@link CornerRadii}, describing the radius of each of the
+ * @return A {@link CornerRadii}, describing the radius of each of the
* Border's corners.
*/
public CornerRadii getCornerRadii() {
@@ -524,7 +538,9 @@ public class BorderSkin extends Containe
}
/**
- * Sets the radii of the Border's corners
+ * Sets the radii of the Border's corners.
+ *
+ * @param cornerRadii The radii for each of the corners.
*/
public void setCornerRadii(CornerRadii cornerRadii) {
if (cornerRadii == null) {
@@ -536,10 +552,10 @@ public class BorderSkin extends Containe
}
/**
- * Sets the radii of the Border's corners
+ * Sets the radii of the Border's corners.
*
* @param cornerRadii A Dictionary
- * {@link CornerRadii#CornerRadii(Dictionary) specifying the four corners}
+ * {@linkplain CornerRadii#CornerRadii(Dictionary) specifying the four corners}.
*/
public final void setCornerRadii(Dictionary<String, ?> cornerRadii) {
if (cornerRadii == null) {
@@ -550,14 +566,18 @@ public class BorderSkin extends Containe
}
/**
- * Sets the radii of the Border's four corners to the same value
+ * Sets the radii of the Border's four corners to the same value.
+ *
+ * @param cornerRadii The integer value to set all four corners' radii.
*/
public final void setCornerRadii(int cornerRadii) {
setCornerRadii(new CornerRadii(cornerRadii));
}
/**
- * Sets the radii of the Border's four corners to the same value
+ * Sets the radii of the Border's four corners to the same value.
+ *
+ * @param cornerRadii The value for the radii (integer value in pixels).
*/
public final void setCornerRadii(Number cornerRadii) {
if (cornerRadii == null) {
@@ -571,7 +591,7 @@ public class BorderSkin extends Containe
* Sets the radii of the Border's corners
*
* @param cornerRadii A single integer value, or a JSON dictionary
- * {@link CornerRadii#CornerRadii(Dictionary) specifying the four corners}
+ * {@linkplain CornerRadii#CornerRadii(Dictionary) specifying the four corners}.
*/
public final void setCornerRadii(String cornerRadii) {
if (cornerRadii == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/BoxPaneSkin.java Tue May 24 18:17:47 2016
@@ -486,7 +486,7 @@ public class BoxPaneSkin extends Contain
}
/**
- * Returns the horizontal alignment of the BoxPane's components within the
+ * @return The horizontal alignment of the BoxPane's components within the
* pane.
*/
public HorizontalAlignment getHorizontalAlignment() {
@@ -501,6 +501,8 @@ public class BoxPaneSkin extends Contain
* style. <p>If the orientation of the pane is VERTICAL, this means the
* alignment of each individual component within the pane. It has no effect
* if the <code>fill</code> style is true.
+ *
+ * @param horizontalAlignment The new horizontal alignment for our children.
*/
public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment) {
if (horizontalAlignment == null) {
@@ -512,7 +514,7 @@ public class BoxPaneSkin extends Contain
}
/**
- * Returns the vertical alignment of the BoxPane's components within the
+ * @return The vertical alignment of the BoxPane's components within the
* pane.
*/
public VerticalAlignment getVerticalAlignment() {
@@ -527,6 +529,8 @@ public class BoxPaneSkin extends Contain
* the orientation of the pane is HORIZONTAL, this means the alignment of
* each individual component within the pane. It has no effect if the
* <code>fill</code> style is true.
+ *
+ * @param verticalAlignment The new horizontal alignment for our children.
*/
public void setVerticalAlignment(VerticalAlignment verticalAlignment) {
if (verticalAlignment == null) {
@@ -538,7 +542,7 @@ public class BoxPaneSkin extends Contain
}
/**
- * Returns the amount of space between the edge of the BoxPane and its
+ * @return The amount of space between the edge of the BoxPane and its
* components.
*/
public Insets getPadding() {
@@ -548,6 +552,8 @@ public class BoxPaneSkin extends Contain
/**
* Sets the amount of space to leave between the edge of the BoxPane and its
* components.
+ *
+ * @param padding The new padding values for all edges.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -576,6 +582,8 @@ public class BoxPaneSkin extends Contain
/**
* Sets the amount of space to leave between the edge of the BoxPane and its
* components, uniformly on all four edges.
+ *
+ * @param padding The new padding value for all edges.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -584,6 +592,8 @@ public class BoxPaneSkin extends Contain
/**
* Sets the amount of space to leave between the edge of the BoxPane and its
* components, uniformly on all four edges.
+ *
+ * @param padding The integer value to use for padding on all edges.
*/
public final void setPadding(Number padding) {
if (padding == null) {
@@ -609,7 +619,7 @@ public class BoxPaneSkin extends Contain
}
/**
- * Returns the amount of space between the BoxPane's components.
+ * @return The amount of space between the BoxPane's components.
*/
public int getSpacing() {
return spacing;
@@ -617,6 +627,8 @@ public class BoxPaneSkin extends Contain
/**
* Sets the amount of space to leave between the BoxPane's components.
+ *
+ * @param spacing The new amount of spacing between components.
*/
public void setSpacing(int spacing) {
if (spacing < 0) {
@@ -628,6 +640,8 @@ public class BoxPaneSkin extends Contain
/**
* Sets the amount of space to leave between the BoxPane's components.
+ *
+ * @param spacing The new amount of spacing to use between components.
*/
public final void setSpacing(Number spacing) {
if (spacing == null) {
@@ -638,7 +652,7 @@ public class BoxPaneSkin extends Contain
}
/**
- * Returns a value indicating whether the BoxPane's components fill the
+ * @return A value indicating whether the BoxPane's components fill the
* available space in the pane in the dimension orthogonal to its
* orientation.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/CardPaneSkin.java Tue May 24 18:17:47 2016
@@ -41,7 +41,12 @@ public class CardPaneSkin extends Contai
* Defines the supported selection change effects.
*/
public enum SelectionChangeEffect {
- CROSSFADE, HORIZONTAL_SLIDE, VERTICAL_SLIDE, HORIZONTAL_FLIP, VERTICAL_FLIP, ZOOM
+ CROSSFADE,
+ HORIZONTAL_SLIDE,
+ VERTICAL_SLIDE,
+ HORIZONTAL_FLIP,
+ VERTICAL_FLIP,
+ ZOOM
}
/**
@@ -488,7 +493,7 @@ public class CardPaneSkin extends Contai
}
/**
- * Returns the amount of space between the edge of the CardPane and its
+ * @return The amount of space between the edge of the CardPane and its
* content.
*/
public Insets getPadding() {
@@ -498,6 +503,8 @@ public class CardPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the CardPane and
* its content.
+ *
+ * @param padding The new padding values for all edges.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -526,6 +533,8 @@ public class CardPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the CardPane and
* its content, uniformly on all four edges.
+ *
+ * @param padding The new single padding value to use for all edges.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -534,6 +543,8 @@ public class CardPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the CardPane and
* its content, uniformly on all four edges.
+ *
+ * @param padding The new integer value to use for the padding on all edges.
*/
public void setPadding(Number padding) {
if (padding == null) {
@@ -600,7 +611,7 @@ public class CardPaneSkin extends Contai
}
/**
- * Sets the circular style, which controls the direction of certain
+ * Returns the circular style, which controls the direction of certain
* transitions (transitions for which a direction makes sense) when looping
* from the first index of a card pane to the last, or vice versa. When this
* style is <tt>false</tt> (the default), directional transitions will
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ContainerSkin.java Tue May 24 18:17:47 2016
@@ -174,8 +174,8 @@ public abstract class ContainerSkin exte
}
/**
- * Returns the {@link Paint} object used to paint the background of the
- * container
+ * @return The {@link Paint} object used to paint the background of the
+ * container.
*/
public Paint getBackgroundPaint() {
return backgroundPaint;
@@ -184,7 +184,7 @@ public abstract class ContainerSkin exte
/**
* Sets the object used to paint the background of the container.
*
- * @param backgroundPaint The {@link Paint} object
+ * @param backgroundPaint The new {@link Paint} object to paint the background.
*/
public void setBackgroundPaint(Paint backgroundPaint) {
this.backgroundPaint = backgroundPaint;
@@ -220,8 +220,8 @@ public abstract class ContainerSkin exte
}
/**
- * Returns the color of the container's background if a solid color has been
- * set as the background; otherwise null.
+ * @return The color of the container's background if a solid color has been
+ * set as the background; otherwise {@code null}.
*/
public Color getBackgroundColor() {
return (backgroundPaint instanceof Color) ? (Color) backgroundPaint : null;
@@ -229,6 +229,8 @@ public abstract class ContainerSkin exte
/**
* Sets the background of the container to a solid color.
+ *
+ * @param backgroundColor The new background color for the container.
*/
public void setBackgroundColor(Color backgroundColor) {
setBackgroundPaint(backgroundColor);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FillPaneSkin.java Tue May 24 18:17:47 2016
@@ -350,7 +350,7 @@ public class FillPaneSkin extends Contai
}
/**
- * Returns the amount of space between the edge of the FillPane and its
+ * @return The amount of space between the edge of the FillPane and its
* components.
*/
public Insets getPadding() {
@@ -360,6 +360,8 @@ public class FillPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the FillPane and
* its components.
+ *
+ * @param padding The new values for padding.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -388,6 +390,8 @@ public class FillPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the FillPane and
* its components, uniformly on all four edges.
+ *
+ * @param padding The new value for padding on all sides.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -396,6 +400,8 @@ public class FillPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the FillPane and
* its components, uniformly on all four edges.
+ *
+ * @param padding The new value for padding on all sides.
*/
public final void setPadding(Number padding) {
if (padding == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/FlowPaneSkin.java Tue May 24 18:17:47 2016
@@ -344,7 +344,7 @@ public class FlowPaneSkin extends Contai
}
/**
- * Returns the amount of space between the edge of the FlowPane and its
+ * @return The amount of space between the edge of the FlowPane and its
* components.
*/
public Insets getPadding() {
@@ -354,6 +354,8 @@ public class FlowPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the FlowPane and
* its components.
+ *
+ * @param padding The individual padding values for each edge.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -382,6 +384,8 @@ public class FlowPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the FlowPane and
* its components, uniformly on all four edges.
+ *
+ * @param padding The single padding value for all four sides.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -390,6 +394,8 @@ public class FlowPaneSkin extends Contai
/**
* Sets the amount of space to leave between the edge of the FlowPane and
* its components, uniformly on all four edges.
+ *
+ * @param padding The single padding value for all four sides.
*/
public final void setPadding(Number padding) {
if (padding == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/GridPaneSkin.java Tue May 24 18:17:47 2016
@@ -428,7 +428,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Gets the padding that will be reserved around the grid pane during
+ * @return The padding that will be reserved around the grid pane during
* layout.
*/
public Insets getPadding() {
@@ -438,6 +438,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the padding that will be reserved around the grid pane during
* layout.
+ *
+ * @param padding The individual padding values for each side.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -451,6 +453,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the padding that will be reserved around the grid pane during
* layout.
+ *
+ * @param padding The single value to use for all sides.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -459,6 +463,9 @@ public class GridPaneSkin extends Contai
/**
* Sets the padding that will be reserved around the grid pane during
* layout.
+ *
+ * @param padding The dictionary of padding values, containing {@code "top"},
+ * {@code "bottom"}, {@code "left}, and {@code "right"} entries.
*/
public final void setPadding(Dictionary<String, ?> padding) {
if (padding == null) {
@@ -471,6 +478,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the padding that will be reserved around the grid pane during
* layout.
+ *
+ * @param padding The single value to use for all sides.
*/
public final void setPadding(Number padding) {
if (padding == null) {
@@ -483,6 +492,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the padding that will be reserved around the grid pane during
* layout.
+ *
+ * @param padding A JSON-format string containing the padding values.
*/
public final void setPadding(String padding) {
if (padding == null) {
@@ -493,7 +504,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Gets the spacing that will be applied in between the grid pane's columns
+ * @return The spacing that will be applied in between the grid pane's columns
* during layout.
*/
public int getHorizontalSpacing() {
@@ -503,6 +514,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the spacing that will be applied in between the grid pane's columns
* during layout.
+ *
+ * @param horizontalSpacing The non-negative spacing value between columns.
*/
public void setHorizontalSpacing(int horizontalSpacing) {
if (horizontalSpacing < 0) {
@@ -514,7 +527,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Gets the spacing that will be applied in between the grid pane's rows
+ * @return The spacing that will be applied in between the grid pane's rows
* during layout.
*/
public int getVerticalSpacing() {
@@ -524,6 +537,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the spacing that will be applied in between the grid pane's rows
* during layout.
+ *
+ * @param verticalSpacing The non-negative spacing value between rows.
*/
public void setVerticalSpacing(int verticalSpacing) {
if (verticalSpacing < 0) {
@@ -535,7 +550,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Tells whether or not horizontal grid lines will be painted in between the
+ * @return Whether or not horizontal grid lines will be painted in between the
* grid pane's rows.
*/
public boolean getShowHorizontalGridLines() {
@@ -545,6 +560,8 @@ public class GridPaneSkin extends Contai
/**
* Sets whether or not horizontal grid lines will be painted in between the
* grid pane's rows.
+ *
+ * @param showHorizontalGridLines Whether to show horizontal grid lines.
*/
public void setShowHorizontalGridLines(boolean showHorizontalGridLines) {
this.showHorizontalGridLines = showHorizontalGridLines;
@@ -552,7 +569,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Tells whether or not vertical grid lines will be painted in between the
+ * @return Whether or not vertical grid lines will be painted in between the
* grid pane's columns.
*/
public boolean getShowVerticalGridLines() {
@@ -562,6 +579,8 @@ public class GridPaneSkin extends Contai
/**
* Sets whether or not vertical grid lines will be painted in between the
* grid pane's columns.
+ *
+ * @param showVerticalGridLines Whether to show the vertical grid lines.
*/
public void setShowVerticalGridLines(boolean showVerticalGridLines) {
this.showVerticalGridLines = showVerticalGridLines;
@@ -569,7 +588,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Gets the color used to paint the grid pane's horizontal grid lines.
+ * @return The color used to paint the grid pane's horizontal grid lines.
*/
public Color getHorizontalGridColor() {
return horizontalGridColor;
@@ -577,6 +596,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the color used to paint the grid pane's horizontal grid lines.
+ *
+ * @param horizontalGridColor The new color for the horizontal grid lines.
*/
public void setHorizontalGridColor(Color horizontalGridColor) {
if (horizontalGridColor == null) {
@@ -606,7 +627,7 @@ public class GridPaneSkin extends Contai
}
/**
- * Gets the color used to paint the grid pane's vertical grid lines.
+ * @return The color used to paint the grid pane's vertical grid lines.
*/
public Color getVerticalGridColor() {
return verticalGridColor;
@@ -614,6 +635,8 @@ public class GridPaneSkin extends Contai
/**
* Sets the color used to paint the grid pane's vertical grid lines.
+ *
+ * @param verticalGridColor The new color for vertical grid lines.
*/
public void setVerticalGridColor(Color verticalGridColor) {
if (verticalGridColor == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ImageViewSkin.java Tue May 24 18:17:47 2016
@@ -265,14 +265,16 @@ public class ImageViewSkin extends Compo
}
/**
- * Returns the color that is painted behind the image
+ * @return The color that is painted behind the image.
*/
public Color getBackgroundColor() {
return backgroundColor;
}
/**
- * Sets the color that is painted behind the image
+ * Sets the color that is painted behind the image.
+ *
+ * @param backgroundColor The new color for behind the image.
*/
public void setBackgroundColor(Color backgroundColor) {
this.backgroundColor = backgroundColor;
@@ -280,7 +282,7 @@ public class ImageViewSkin extends Compo
}
/**
- * Sets the color that is painted behind the image
+ * Sets the color that is painted behind the image.
*
* @param backgroundColor Any of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
@@ -295,7 +297,7 @@ public class ImageViewSkin extends Compo
}
/**
- * Returns the opacity of the image, in [0,1].
+ * @return The opacity of the image, in [0,1].
*/
public float getOpacity() {
return opacity;
@@ -304,7 +306,7 @@ public class ImageViewSkin extends Compo
/**
* Sets the opacity of the image.
*
- * @param opacity A number between 0 (transparent) and 1 (opaque)
+ * @param opacity A number between 0 (transparent) and 1 (opaque).
*/
public void setOpacity(float opacity) {
if (opacity < 0 || opacity > 1) {
@@ -318,7 +320,7 @@ public class ImageViewSkin extends Compo
/**
* Sets the opacity of the image.
*
- * @param opacity A number between 0 (transparent) and 1 (opaque)
+ * @param opacity A number between 0 (transparent) and 1 (opaque).
*/
public final void setOpacity(Number opacity) {
if (opacity == null) {
@@ -329,7 +331,7 @@ public class ImageViewSkin extends Compo
}
/**
- * Returns the horizontal alignment of the image.
+ * @return The horizontal alignment of the image.
*/
public HorizontalAlignment getHorizontalAlignment() {
return horizontalAlignment;
@@ -338,6 +340,8 @@ public class ImageViewSkin extends Compo
/**
* Sets the horizontal alignment of the image. Ignored if the
* <code>fill</code> style is true.
+ *
+ * @param horizontalAlignment The new alignment value.
*/
public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment) {
if (horizontalAlignment == null) {
@@ -350,7 +354,7 @@ public class ImageViewSkin extends Compo
}
/**
- * Returns the vertical alignment of the image.
+ * @return The vertical alignment of the image.
*/
public VerticalAlignment getVerticalAlignment() {
return verticalAlignment;
@@ -359,6 +363,8 @@ public class ImageViewSkin extends Compo
/**
* Sets the vertical alignment of the image. Ignored if the
* <code>fill</code> style is true.
+ *
+ * @param verticalAlignment The new alignment value.
*/
public void setVerticalAlignment(VerticalAlignment verticalAlignment) {
if (verticalAlignment == null) {
@@ -371,7 +377,7 @@ public class ImageViewSkin extends Compo
}
/**
- * Returns a boolean indicating whether the image will be scaled to fit the
+ * @return A boolean indicating whether the image will be scaled to fit the
* space in which it is placed.
*/
public boolean getFill() {
@@ -383,6 +389,8 @@ public class ImageViewSkin extends Compo
* space in which it is placed. Note that for scaling to occur, the
* ImageView must specify a preferred size or be placed in a container that
* constrains its size.
+ *
+ * @param fill The new fill flag value.
*/
public void setFill(boolean fill) {
this.fill = fill;
@@ -391,7 +399,7 @@ public class ImageViewSkin extends Compo
}
/**
- * Returns a boolean indicating whether, when the image is scaled, its
+ * @return A boolean indicating whether, when the image is scaled, its
* aspect ratio is preserved.
*/
public boolean getPreserveAspectRatio() {
@@ -401,6 +409,8 @@ public class ImageViewSkin extends Compo
/**
* Sets a boolean indicating whether, when the image is scaled, its aspect
* ratio is preserved. Ignored if the <code>fill</code> style is false.
+ *
+ * @param preserveAspectRatio The new flag value.
*/
public void setPreserveAspectRatio(boolean preserveAspectRatio) {
this.preserveAspectRatio = preserveAspectRatio;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/LabelSkin.java Tue May 24 18:17:47 2016
@@ -452,14 +452,16 @@ public class LabelSkin extends Component
}
/**
- * Returns the font used in rendering the Label's text
+ * @return The font used in rendering the Label's text.
*/
public Font getFont() {
return font;
}
/**
- * Sets the font used in rendering the Label's text
+ * Sets the font used in rendering the Label's text.
+ *
+ * @param font The new font to use to render the text.
*/
public void setFont(Font font) {
if (font == null) {
@@ -473,7 +475,7 @@ public class LabelSkin extends Component
/**
* Sets the font used in rendering the Label's text
*
- * @param font A {@link ComponentSkin#decodeFont(String) font specification}
+ * @param font A {@linkplain ComponentSkin#decodeFont(String) font specification}.
*/
public final void setFont(String font) {
if (font == null) {
@@ -486,7 +488,7 @@ public class LabelSkin extends Component
/**
* Sets the font used in rendering the Label's text
*
- * @param font A dictionary {@link Theme#deriveFont describing a font}
+ * @param font A dictionary {@linkplain Theme#deriveFont describing a font}.
*/
public final void setFont(Dictionary<String, ?> font) {
if (font == null) {
@@ -497,7 +499,7 @@ public class LabelSkin extends Component
}
/**
- * Returns the foreground color of the text of the label.
+ * @return The foreground color of the text of the label.
*/
public Color getColor() {
return color;
@@ -505,6 +507,8 @@ public class LabelSkin extends Component
/**
* Sets the foreground color of the text of the label.
+ *
+ * @param color The new foreground color for the label text.
*/
public void setColor(Color color) {
if (color == null) {
@@ -530,7 +534,7 @@ public class LabelSkin extends Component
}
/**
- * Returns the foreground color of the text of the label when disabled.
+ * @return The foreground color of the text of the label when disabled.
*/
public Color getDisabledColor() {
return disabledColor;
@@ -538,6 +542,8 @@ public class LabelSkin extends Component
/**
* Sets the foreground color of the text of the label when disabled.
+ *
+ * @param color The new disabled text color.
*/
public void setDisabledColor(Color color) {
if (color == null) {
@@ -563,7 +569,7 @@ public class LabelSkin extends Component
}
/**
- * Returns the background color of the label.
+ * @return The background color of the label.
*/
public Color getBackgroundColor() {
return backgroundColor;
@@ -571,6 +577,8 @@ public class LabelSkin extends Component
/**
* Sets the background color of the label.
+ *
+ * @param backgroundColor The new background color for the label.
*/
public void setBackgroundColor(Color backgroundColor) {
this.backgroundColor = backgroundColor;
@@ -628,7 +636,7 @@ public class LabelSkin extends Component
}
/**
- * Returns the amount of space to leave between the edge of the Label and
+ * @return The amount of space to leave between the edge of the Label and
* its text.
*/
public Insets getPadding() {
@@ -638,6 +646,8 @@ public class LabelSkin extends Component
/**
* Sets the amount of space to leave between the edge of the Label and its
* text.
+ *
+ * @param padding The new value of the padding for each edge.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -666,6 +676,8 @@ public class LabelSkin extends Component
/**
* Sets the amount of space to leave between the edge of the Label and its
* text, uniformly on all four edges.
+ *
+ * @param padding The new single padding value to use for all edges.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -674,6 +686,8 @@ public class LabelSkin extends Component
/**
* Sets the amount of space to leave between the edge of the Label and its
* text, uniformly on all four edges.
+ *
+ * @param padding The new (integer) padding value to use for all edges.
*/
public final void setPadding(Number padding) {
if (padding == null) {
@@ -699,7 +713,7 @@ public class LabelSkin extends Component
}
/**
- * Returns true if the text of the label will be wrapped to fit the Label's
+ * @return {@code true} if the text of the label will be wrapped to fit the Label's
* width.
*/
public boolean getWrapText() {
@@ -710,8 +724,10 @@ public class LabelSkin extends Component
* Sets whether the text of the label will be wrapped to fit the Label's
* width. Note that for wrapping to occur, the Label must specify a
* preferred width or be placed in a container that constrains its width.
- * Also note that newline characters (if wrapping is set true) will cause a
+ * <p>Also note that newline characters (if wrapping is set true) will cause a
* hard line break.
+ *
+ * @param wrapText Whether or not to wrap the Label's text within its width.
*/
public void setWrapText(boolean wrapText) {
this.wrapText = wrapText;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/SeparatorSkin.java Tue May 24 18:17:47 2016
@@ -176,14 +176,16 @@ public class SeparatorSkin extends Compo
}
/**
- * Returns the font used in rendering the Separator's heading
+ * @return The font used in rendering the Separator's heading.
*/
public Font getFont() {
return font;
}
/**
- * Sets the font used in rendering the Separator's heading
+ * Sets the font used in rendering the Separator's heading.
+ *
+ * @param font The new font for the heading.
*/
public void setFont(Font font) {
if (font == null) {
@@ -195,9 +197,9 @@ public class SeparatorSkin extends Compo
}
/**
- * Sets the font used in rendering the Separator's heading
+ * Sets the font used in rendering the Separator's heading.
*
- * @param font A {@link ComponentSkin#decodeFont(String) font specification}
+ * @param font A {@linkplain ComponentSkin#decodeFont(String) font specification}.
*/
public final void setFont(String font) {
if (font == null) {
@@ -208,9 +210,9 @@ public class SeparatorSkin extends Compo
}
/**
- * Sets the font used in rendering the Separator's heading
+ * Sets the font used in rendering the Separator's heading.
*
- * @param font A dictionary {@link Theme#deriveFont describing a font}
+ * @param font A dictionary {@link Theme#deriveFont describing a font}.
*/
public final void setFont(Dictionary<String, ?> font) {
if (font == null) {
@@ -221,14 +223,16 @@ public class SeparatorSkin extends Compo
}
/**
- * Returns the color of the Separator's horizontal rule
+ * @return The color of the Separator's horizontal rule.
*/
public Color getColor() {
return color;
}
/**
- * Sets the color of the Separator's horizontal rule
+ * Sets the color of the Separator's horizontal rule.
+ *
+ * @param color The new color for the horizontal rule.
*/
public void setColor(Color color) {
if (color == null) {
@@ -240,7 +244,7 @@ public class SeparatorSkin extends Compo
}
/**
- * Sets the color of the Separator's horizontal rule
+ * Sets the color of the Separator's horizontal rule.
*
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
@@ -254,14 +258,16 @@ public class SeparatorSkin extends Compo
}
/**
- * Returns the color of the text in the heading
+ * @return The color of the text in the heading.
*/
public Color getHeadingColor() {
return headingColor;
}
/**
- * Sets the color of the text in the heading
+ * Sets the color of the text in the heading.
+ *
+ * @param headingColor The new color for the heading text.
*/
public void setHeadingColor(Color headingColor) {
if (headingColor == null) {
@@ -273,7 +279,7 @@ public class SeparatorSkin extends Compo
}
/**
- * Sets the color of the text in the heading
+ * Sets the color of the text in the heading.
*
* @param headingColor Any of the {@linkplain GraphicsUtilities#decodeColor
* color values recognized by Pivot}.
@@ -287,14 +293,16 @@ public class SeparatorSkin extends Compo
}
/**
- * Returns the thickness of the Separator's horizontal rule
+ * @return The thickness of the Separator's horizontal rule.
*/
public int getThickness() {
return thickness;
}
/**
- * Sets the thickness of the Separator's horizontal rule
+ * Sets the thickness of the Separator's horizontal rule.
+ *
+ * @param thickness The new rule thickness (in pixels).
*/
public void setThickness(int thickness) {
if (thickness < 0) {
@@ -305,7 +313,9 @@ public class SeparatorSkin extends Compo
}
/**
- * Sets the thickness of the Separator's horizontal rule
+ * Sets the thickness of the Separator's horizontal rule.
+ *
+ * @param thickness The new integer value for the rule thickness (in pixels).
*/
public final void setThickness(Number thickness) {
if (thickness == null) {
@@ -316,7 +326,7 @@ public class SeparatorSkin extends Compo
}
/**
- * Returns the amount of space surrounding (left/right) the Separator's
+ * @return The amount of space surrounding (left/right) the Separator's
* heading, and above and below the entire component.
*/
public Insets getPadding() {
@@ -326,6 +336,8 @@ public class SeparatorSkin extends Compo
/**
* Sets the amount of space to leave around the Separator's heading, and
* above and below the entire component.
+ *
+ * @param padding The new padding values.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -354,6 +366,8 @@ public class SeparatorSkin extends Compo
/**
* Sets the amount of space to leave around the Separator's heading, and
* above and below the entire component.
+ *
+ * @param padding The new single padding value for all areas.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -362,6 +376,8 @@ public class SeparatorSkin extends Compo
/**
* Sets the amount of space to leave around the Separator's heading, and
* above and below the entire component.
+ *
+ * @param padding The new integer value to use for padding in all areas.
*/
public final void setPadding(Number padding) {
if (padding == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/StackPaneSkin.java Tue May 24 18:17:47 2016
@@ -98,7 +98,7 @@ public class StackPaneSkin extends Conta
}
/**
- * Returns the amount of space between the edge of the StackPane and its
+ * @return The amount of space between the edge of the StackPane and its
* components.
*/
public Insets getPadding() {
@@ -108,6 +108,8 @@ public class StackPaneSkin extends Conta
/**
* Sets the amount of space to leave between the edge of the StackPane and
* its components.
+ *
+ * @param padding The individual padding amounts for each edge.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -136,6 +138,8 @@ public class StackPaneSkin extends Conta
/**
* Sets the amount of space to leave between the edge of the StackPane and
* its components, uniformly on all four edges.
+ *
+ * @param padding The single padding value for all four edges.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -144,6 +148,8 @@ public class StackPaneSkin extends Conta
/**
* Sets the amount of space to leave between the edge of the StackPane and
* its components, uniformly on all four edges.
+ *
+ * @param padding The single padding value for all four edges.
*/
public final void setPadding(Number padding) {
if (padding == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TablePaneSkin.java Tue May 24 18:17:47 2016
@@ -754,7 +754,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Returns the amount of space that will be reserved around the inside edges
+ * @return The amount of space that will be reserved around the inside edges
* of the table pane.
*/
public Insets getPadding() {
@@ -764,6 +764,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the amount of space that will be reserved around the inside edges of
* the table pane.
+ *
+ * @param padding The individual padding amounts for each edge.
*/
public void setPadding(Insets padding) {
if (padding == null) {
@@ -777,6 +779,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the amount of space that will be reserved around the inside edges of
* the table pane.
+ *
+ * @param padding The single padding value to use for all the edges.
*/
public final void setPadding(int padding) {
setPadding(new Insets(padding));
@@ -800,6 +804,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the amount of space that will be reserved around the inside edges of
* the table pane.
+ *
+ * @param padding The single padding value to use for all the edges.
*/
public final void setPadding(Number padding) {
if (padding == null) {
@@ -825,7 +831,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Gets the spacing that will be applied between the table pane's columns
+ * @return The spacing that will be applied between the table pane's columns
* during layout.
*/
public int getHorizontalSpacing() {
@@ -835,6 +841,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the spacing that will be applied between the table pane's columns
* during layout.
+ *
+ * @param horizontalSpacing The new spacing value.
*/
public void setHorizontalSpacing(int horizontalSpacing) {
if (horizontalSpacing < 0) {
@@ -846,7 +854,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Gets the spacing that will be applied in between the table pane's rows
+ * @return The spacing that will be applied in between the table pane's rows
* during layout.
*/
public int getVerticalSpacing() {
@@ -856,6 +864,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the spacing that will be applied in between the table pane's rows
* during layout.
+ *
+ * @param verticalSpacing The new spacing value.
*/
public void setVerticalSpacing(int verticalSpacing) {
if (verticalSpacing < 0) {
@@ -867,7 +877,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Tells whether or not horizontal grid lines will be painted in between the
+ * @return Whether or not horizontal grid lines will be painted in between the
* table pane's rows.
*/
public boolean getShowHorizontalGridLines() {
@@ -877,6 +887,8 @@ public class TablePaneSkin extends Conta
/**
* Sets whether or not horizontal grid lines will be painted in between the
* table pane's rows.
+ *
+ * @param showHorizontalGridLines Whether to show the horizontal lines.
*/
public void setShowHorizontalGridLines(boolean showHorizontalGridLines) {
this.showHorizontalGridLines = showHorizontalGridLines;
@@ -884,7 +896,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Tells whether or not vertical grid lines will be painted in between the
+ * @return Whether or not vertical grid lines will be painted in between the
* table pane's columns.
*/
public boolean getShowVerticalGridLines() {
@@ -894,6 +906,8 @@ public class TablePaneSkin extends Conta
/**
* Sets whether or not vertical grid lines will be painted in between the
* table pane's columns.
+ *
+ * @param showVerticalGridLines Whether to show the vertical lines.
*/
public void setShowVerticalGridLines(boolean showVerticalGridLines) {
this.showVerticalGridLines = showVerticalGridLines;
@@ -901,7 +915,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Gets the color used to paint the table pane's horizontal grid lines.
+ * @return The color used to paint the table pane's horizontal grid lines.
*/
public Color getHorizontalGridColor() {
return horizontalGridColor;
@@ -909,6 +923,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the color used to paint the table pane's horizontal grid lines.
+ *
+ * @param horizontalGridColor The new grid line color.
*/
public void setHorizontalGridColor(Color horizontalGridColor) {
if (horizontalGridColor == null) {
@@ -938,7 +954,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Gets the color used to paint the table pane's vertical grid lines.
+ * @return The color used to paint the table pane's vertical grid lines.
*/
public Color getVerticalGridColor() {
return verticalGridColor;
@@ -946,6 +962,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the color used to paint the table pane's vertical grid lines.
+ *
+ * @param verticalGridColor The new grid line color.
*/
public void setVerticalGridColor(Color verticalGridColor) {
if (verticalGridColor == null) {
@@ -975,7 +993,7 @@ public class TablePaneSkin extends Conta
}
/**
- * Gets the background color used to paint the highlighted rows and columns.
+ * @return The background color used to paint the highlighted rows and columns.
*/
public Color getHighlightBackgroundColor() {
return highlightBackgroundColor;
@@ -983,6 +1001,8 @@ public class TablePaneSkin extends Conta
/**
* Sets the background color used to paint the highlighted rows and columns.
+ *
+ * @param highlightBackgroundColor The new highlight color.
*/
public void setHighlightBackgroundColor(Color highlightBackgroundColor) {
if (highlightBackgroundColor == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java Tue May 24 18:17:47 2016
@@ -501,14 +501,16 @@ public class TextAreaSkin extends Compon
}
/**
- * Returns the font of the text
+ * @return The font of the text.
*/
public Font getFont() {
return font;
}
/**
- * Sets the font of the text
+ * Sets the font of the text.
+ *
+ * @param font The new font for the text.
*/
public void setFont(Font font) {
if (font == null) {
@@ -532,7 +534,7 @@ public class TextAreaSkin extends Compon
}
/**
- * Sets the font of the text
+ * Sets the font of the text.
*
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
@@ -545,7 +547,7 @@ public class TextAreaSkin extends Compon
}
/**
- * Sets the font of the text
+ * Sets the font of the text.
*
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
@@ -558,14 +560,16 @@ public class TextAreaSkin extends Compon
}
/**
- * Returns the foreground color of the text
+ * @return The foreground color of the text.
*/
public Color getColor() {
return color;
}
/**
- * Sets the foreground color of the text
+ * Sets the foreground color of the text.
+ *
+ * @param color The new foreground text color.
*/
public void setColor(Color color) {
if (color == null) {
@@ -577,7 +581,7 @@ public class TextAreaSkin extends Compon
}
/**
- * Sets the foreground color of the text
+ * Sets the foreground color of the text.
*
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
@@ -713,14 +717,16 @@ public class TextAreaSkin extends Compon
}
/**
- * Returns the amount of space between the edge of the TextArea and its text
+ * @return The amount of space between the edge of the TextArea and its text.
*/
public Insets getMargin() {
return margin;
}
/**
- * Sets the amount of space between the edge of the TextArea and its text
+ * Sets the amount of space between the edge of the TextArea and its text.
+ *
+ * @param margin The individual margin values for all edges.
*/
public void setMargin(Insets margin) {
if (margin == null) {
@@ -732,7 +738,7 @@ public class TextAreaSkin extends Compon
}
/**
- * Sets the amount of space between the edge of the TextArea and its text
+ * Sets the amount of space between the edge of the TextArea and its text.
*
* @param margin A dictionary with keys in the set {left, top, bottom,
* right}.
@@ -746,14 +752,18 @@ public class TextAreaSkin extends Compon
}
/**
- * Sets the amount of space between the edge of the TextArea and its text
+ * Sets the amount of space between the edge of the TextArea and its text.
+ *
+ * @param margin The single value to use for all the margins.
*/
public final void setMargin(int margin) {
setMargin(new Insets(margin));
}
/**
- * Sets the amount of space between the edge of the TextArea and its text
+ * Sets the amount of space between the edge of the TextArea and its text.
+ *
+ * @param margin The single value to use for all the margins.
*/
public final void setMargin(Number margin) {
if (margin == null) {
@@ -764,7 +774,7 @@ public class TextAreaSkin extends Compon
}
/**
- * Sets the amount of space between the edge of the TextArea and its text
+ * Sets the amount of space between the edge of the TextArea and its text.
*
* @param margin A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java?rev=1745388&r1=1745387&r2=1745388&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java Tue May 24 18:17:47 2016
@@ -438,14 +438,16 @@ public class TextPaneSkin extends Contai
}
/**
- * Returns the font of the text
+ * @return The font of the text.
*/
public Font getFont() {
return font;
}
/**
- * Sets the font of the text
+ * Sets the font of the text.
+ *
+ * @param font The new font for all the text.
*/
public void setFont(Font font) {
if (font == null) {
@@ -457,7 +459,7 @@ public class TextPaneSkin extends Contai
}
/**
- * Sets the font of the text
+ * Sets the font of the text.
*
* @param font A {@link ComponentSkin#decodeFont(String) font specification}
*/
@@ -470,7 +472,7 @@ public class TextPaneSkin extends Contai
}
/**
- * Sets the font of the text
+ * Sets the font of the text.
*
* @param font A dictionary {@link Theme#deriveFont describing a font}
*/
@@ -483,14 +485,16 @@ public class TextPaneSkin extends Contai
}
/**
- * Returns the foreground color of the text
+ * @return The foreground color of the text.
*/
public Color getColor() {
return color;
}
/**
- * Sets the foreground color of the text
+ * Sets the foreground color of the text.
+ *
+ * @param color The new text color.
*/
public void setColor(Color color) {
if (color == null) {
@@ -502,7 +506,7 @@ public class TextPaneSkin extends Contai
}
/**
- * Sets the foreground color of the text
+ * Sets the foreground color of the text.
*
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
@@ -621,8 +625,8 @@ public class TextPaneSkin extends Contai
}
/**
- * Returns the amount of space between the edge of the TextPane and its
- * Document
+ * @return The amount of space between the edge of the TextPane and its
+ * Document.
*/
public Insets getMargin() {
return margin;
@@ -630,7 +634,9 @@ public class TextPaneSkin extends Contai
/**
* Sets the amount of space between the edge of the TextPane and its
- * Document
+ * Document.
+ *
+ * @param margin The new set of margin values.
*/
public void setMargin(Insets margin) {
if (margin == null) {
@@ -643,7 +649,7 @@ public class TextPaneSkin extends Contai
/**
* Sets the amount of space between the edge of the TextPane and its
- * Document
+ * Document.
*
* @param margin A dictionary with keys in the set {left, top, bottom,
* right}.
@@ -658,7 +664,9 @@ public class TextPaneSkin extends Contai
/**
* Sets the amount of space between the edge of the TextPane and its
- * Document
+ * Document.
+ *
+ * @param margin The single margin value for all edges.
*/
public final void setMargin(int margin) {
setMargin(new Insets(margin));
@@ -666,7 +674,9 @@ public class TextPaneSkin extends Contai
/**
* Sets the amount of space between the edge of the TextPane and its
- * Document
+ * Document.
+ *
+ * @param margin The new single margin value for all the edges.
*/
public final void setMargin(Number margin) {
if (margin == null) {
@@ -678,7 +688,7 @@ public class TextPaneSkin extends Contai
/**
* Sets the amount of space between the edge of the TextPane and its
- * Document
+ * Document.
*
* @param margin A string containing an integer or a JSON dictionary with
* keys left, top, bottom, and/or right.