Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
8271091: Missing API docs in UI controls classes 
Reviewed-by: nlisker, kcr
  • Loading branch information
@aghaisas
aghaisas committed Oct 29, 2021
1 parent e7a106f commit a947405
Show file tree
Hide file tree
Showing 49 changed files with 254 additions and 122 deletions.
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/AreaChart.java
View file
Expand Up @@ -579,8 +579,9 @@ public StyleableProperty<Boolean> getStyleableProperty(AreaChart<?,?> node) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/Axis.java
View file
Expand Up @@ -1194,8 +1194,9 @@ public StyleableProperty<Boolean> getStyleableProperty(Axis<?> n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/BarChart.java
View file
Expand Up @@ -608,8 +608,9 @@ public StyleableProperty<Number> getStyleableProperty(BarChart<?,?> node) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/CategoryAxis.java
View file
Expand Up @@ -610,8 +610,9 @@ public StyleableProperty<Boolean> getStyleableProperty(CategoryAxis n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/Chart.java
View file
Expand Up @@ -493,8 +493,9 @@ public StyleableProperty<Boolean> getStyleableProperty(Chart node) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/LineChart.java
View file
Expand Up @@ -570,8 +570,9 @@ public StyleableProperty<Boolean> getStyleableProperty(LineChart<?,?> node) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/NumberAxis.java
View file
Expand Up @@ -482,8 +482,9 @@ public StyleableProperty<Number> getStyleableProperty(NumberAxis n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/PieChart.java
View file
Expand Up @@ -1102,8 +1102,9 @@ public StyleableProperty<Number> getStyleableProperty(PieChart node) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/StackedAreaChart.java
View file
Expand Up @@ -886,8 +886,9 @@ public StyleableProperty<Boolean> getStyleableProperty(StackedAreaChart<?,?> nod
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/StackedBarChart.java
View file
Expand Up @@ -578,8 +578,9 @@ public StyleableProperty<Number> getStyleableProperty(StackedBarChart<?,?> node)
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/ValueAxis.java
View file
Expand Up @@ -581,8 +581,9 @@ public StyleableProperty<Boolean> getStyleableProperty(ValueAxis<? extends Numbe
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/chart/XYChart.java
View file
Expand Up @@ -1184,8 +1184,9 @@ public StyleableProperty<Boolean> getStyleableProperty(XYChart<?,?> node) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
4 changes: 3 additions & 1 deletion modules/javafx.controls/src/main/java/javafx/scene/control/CheckMenuItem.java
View file
Expand Up @@ -85,7 +85,9 @@ public class CheckMenuItem extends MenuItem {
* Constructors *
* *
**************************************************************************/

/**
* Creates an empty {@code CheckMenuItem}.
*/
public CheckMenuItem() {
this(null,null);
}
Expand Down
8 changes: 5 additions & 3 deletions modules/javafx.controls/src/main/java/javafx/scene/control/Control.java
View file
Expand Up @@ -809,8 +809,9 @@ public StyleableProperty<String> getStyleableProperty(Control n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down Expand Up @@ -870,7 +871,8 @@ public StyleableProperty<String> getStyleableProperty(Control n) {
}

/**
* @return unmodifiable list of the controls css styleable properties
* Gets the unmodifiable list of the control's CSS-styleable properties.
* @return the unmodifiable list of the control's CSS-styleable properties
* @since JavaFX 8.0
*/
protected List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData() {
Expand Down
4 changes: 4 additions & 0 deletions modules/javafx.controls/src/main/java/javafx/scene/control/DateCell.java
View file
Expand Up @@ -41,6 +41,10 @@
* @since JavaFX 8.0
*/
public class DateCell extends Cell<LocalDate> {

/**
* Creates a default {@code DateCell}.
*/
public DateCell() {
getStyleClass().add(DEFAULT_STYLE_CLASS);
setAccessibleRole(AccessibleRole.TEXT);
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/DatePicker.java
View file
Expand Up @@ -464,8 +464,9 @@ private static class StyleableProperties {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
return StyleableProperties.STYLEABLES;
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/DialogPane.java
View file
Expand Up @@ -1221,8 +1221,9 @@ public StyleableProperty<String> getStyleableProperty(DialogPane n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
return StyleableProperties.STYLEABLES;
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java
View file
Expand Up @@ -1080,8 +1080,9 @@ public StyleableProperty<Number> getStyleableProperty(Labeled n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/ListView.java
View file
Expand Up @@ -1073,8 +1073,9 @@ public StyleableProperty<Orientation> getStyleableProperty(ListView<?> n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/MenuBar.java
View file
Expand Up @@ -234,8 +234,9 @@ private static class StyleableProperties {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
10 changes: 10 additions & 0 deletions modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModelBase.java
View file
Expand Up @@ -154,7 +154,17 @@ public MultipleSelectionModelBase() {
* T that is related to the given index.
*/
protected abstract T getModelItem(int index);

/**
* Focuses the item at the given index.
* @param index the index of the item to be focused
*/
protected abstract void focus(int index);

/**
* Gets the index of the focused item.
* @return the index of the focused item
*/
protected abstract int getFocusedIndex();

static class ShiftParams {
Expand Down
5 changes: 3 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java
View file
Expand Up @@ -376,8 +376,9 @@ public StyleableProperty<Number> getStyleableProperty(Pagination n) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand Down
44 changes: 21 additions & 23 deletions modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java
View file
Expand Up @@ -109,7 +109,7 @@ public class PopupControl extends PopupWindow implements Skinnable, Styleable {
protected CSSBridge bridge;

/**
* Create a new empty PopupControl.
* Creates a new empty {@code PopupControl}.
*/
public PopupControl() {
super();
Expand All @@ -132,7 +132,7 @@ public PopupControl() {
* (<a href="http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier">CSS ID Specification</a>).
*
* @return the id property
* @defaultValue null
* @defaultValue {@code null}
*/
public final StringProperty idProperty() { return bridge.idProperty(); }

Expand All @@ -145,7 +145,7 @@ public PopupControl() {
*
* @param value the id assigned to this {@code PopupControl} using the {@code setId}
* method or {@code null}, if no id has been assigned.
* @defaultValue null
* @defaultValue {@code null}
*/
public final void setId(String value) { idProperty().set(value); }

Expand All @@ -158,7 +158,7 @@ public PopupControl() {
*
* @return the id assigned to this {@code PopupControl} using the {@code setId}
* method or {@code null}, if no id has been assigned.
* @defaultValue null
* @defaultValue {@code null}
*/
@Override public final String getId() { return idProperty().get(); }

Expand All @@ -168,31 +168,20 @@ public PopupControl() {
*/
@Override public final ObservableList<String> getStyleClass() { return bridge.getStyleClass(); }

/**
* A string representation of the CSS style associated with this
* specific {@code PopupControl}. This is analogous to the "style" attribute of an
* HTML element. Note that, like the HTML style attribute, this
* variable contains style properties and values and not the
* selector portion of a style rule.
* @param value The inline CSS style to use for this {@code PopupControl}.
* {@code null} is implicitly converted to an empty String.
* @defaultValue empty string
*/
public final void setStyle(String value) { styleProperty().set(value); }
@Override public final String getStyle() { return styleProperty().get(); }

// TODO: javadoc copied from property for the sole purpose of providing a return tag
/**
* A string representation of the CSS style associated with this
* specific {@code PopupControl}. This is analogous to the "style" attribute of an
* HTML element. Note that, like the HTML style attribute, this
* variable contains style properties and values and not the
* selector portion of a style rule.
* @defaultValue empty string
* @return The inline CSS style associated with this {@code PopupControl}.
* If this {@code PopupControl} does not have an inline style,
* an empty String is returned.
* <p>A value of {@code null} is implicitly converted to an empty {@code String}.</p>
*
* @return the {@code style} property
* @defaultValue {@code null}
*/
@Override public final String getStyle() { return styleProperty().get(); }
public final StringProperty styleProperty() { return bridge.styleProperty(); }

/**
Expand All @@ -204,7 +193,7 @@ public PopupControl() {
* {@code Skin}. Every {@code Skin} maintains a back reference to the
* {@code PopupControl}.
* <p>
* A skin may be null.
* A skin may be {@code null}.
*/
@Override public final ObjectProperty<Skin<?>> skinProperty() {
return skin;
Expand Down Expand Up @@ -1029,8 +1018,9 @@ public StyleableProperty<String> getStyleableProperty(CSSBridge cssBridge) {
}

/**
* @return The CssMetaData associated with this class, which may include the
* CssMetaData of its superclasses.
* Gets the {@code CssMetaData} associated with this class, which may include the
* {@code CssMetaData} of its superclasses.
* @return the {@code CssMetaData}
* @since JavaFX 8.0
*/
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData() {
Expand All @@ -1047,6 +1037,8 @@ public StyleableProperty<String> getStyleableProperty(CSSBridge cssBridge) {
}

/**
* Used to specify that a pseudo-class of this node has changed.
*
* @param pseudoClass the pseudo class
* @param active the active state
* @see Node#pseudoClassStateChanged(javafx.css.PseudoClass, boolean)
Expand Down Expand Up @@ -1134,6 +1126,12 @@ protected class CSSBridge extends Pane {
CSSBridgeHelper.initHelper(this);
}

/**
* Constructor for subclasses to call.
*/
protected CSSBridge() {
}

/**
* Requests a layout pass to be performed before the next scene is
* rendered. This is batched up asynchronously to happen once per
Expand Down

1 comment on commit a947405

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

Please sign in to comment.