Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8344367: Fix mistakes in FX API docs #1642

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ public Axis() {
// -------------- METHODS ------------------------------------------------------------------------------------------

/**
* See if the current range is valid, if it is not then any range dependent calulcations need to redone on the next layout pass
* See if the current range is valid, if it is not then any range dependent calculations need to redone on the next layout pass
*
* @return true if current range calculations are valid
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -976,7 +976,7 @@ protected final void removeSeriesFromDisplay(Series<X, Y> series) {

/**
* XYChart maintains a list of all series currently displayed this includes all current series + any series that
* have recently been deleted that are in the process of being faded(animated) out. This creates and returns a
* have recently been deleted that are in the process of being faded (animated) out. This creates and returns a
* iterator over that list. This is what implementations of XYChart should use when plotting data.
*
* @return iterator over currently displayed series
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* are a very convenient way for data visualization. Application
* developers can make use of these off-the-rack graphical charts
* provided by the JavaFX runtime, to visualize a wide variety of data.</P>
* <P>Commom types of charts such as {@link javafx.scene.chart.BarChart
* <P>Common types of charts such as {@link javafx.scene.chart.BarChart
* Bar}, {@link javafx.scene.chart.LineChart Line}, {@link
* javafx.scene.chart.AreaChart Area}, {@link
* javafx.scene.chart.PieChart Pie}, {@link
Expand Down Expand Up @@ -111,7 +111,7 @@
* <TD>
* <P>Plots symbols for the data points in a series. This type of
* chart is useful in viewing distribution of data and its
* corelation, if there is any clustering.</P>
* correlation, if there is any clustering.</P>
* </TD>
* </TR>
* </TABLE>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public ResizeFeaturesBase(@NamedArg("column") TableColumnBase<S,?> column, @Name
/**
* Returns the width of the area available for columns.
*
* @return the width availabe for columns
* @return the width available for columns
*
* @since 20
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ public TextFormatter(@NamedArg("valueConverter") StringConverter<V> valueConvert
/**
* The converter between the values and text.
* It maintains a "binding" between the {@link javafx.scene.control.TextInputControl#textProperty()} }
* and {@link #valueProperty()} }. The value is updated when the control loses it's focus or it is commited (TextField only).
* Setting the value will update the text of the control, usin the provided converter.
* and {@link #valueProperty()} }. The value is updated when the control loses it's focus or it is committed (TextField only).
* Setting the value will update the text of the control, using the provided converter.
*
* If it's impossible to convert text to value, an exception should be thrown.
* @return StringConverter for values or null if none provided
Expand All @@ -143,7 +143,7 @@ public final UnaryOperator<Change> getFilter() {

/**
* The current value for this formatter. When the formatter is set on a {@code TextInputControl} and has a
* {@code valueConverter}, the value is set by the control, when the text is commited.
* {@code valueConverter}, the value is set by the control, when the text is committed.
*/
private final ObjectProperty<V> value = new ObjectPropertyBase<>() {

Expand Down Expand Up @@ -231,7 +231,7 @@ void updateValue(String text) {
* an empty {@code text}. Similarly, if you want to delete some different or additional text, just set the {@code range}.
* If you want to remove first word instead of the second, just call {@code setRange(0,5)}</li>
* <li><b>Some text was added:</b> Now the {@code range} is empty (means nothing was deleted), but it's value is still important.
* Both the start and end of the {@code range} point to the index wheret the new text was added. E.g. adding "ipsum " to "Lorem dolor sit amet"
* Both the start and end of the {@code range} point to the index where the new text was added. E.g. adding "ipsum " to "Lorem dolor sit amet"
* would result in a change with {@code range} of (6,6) and {@code text} containing the String "ipsum ".</li>
* <li><b>Some text was replaced:</b> The combination of the 2 cases above. Both {@code text} and {@code range} are not empty. The text in {@code range} is deleted
* and replaced by {@code text} in the Change. The new text is added instead of the old text, which is at the beginning of the {@code range}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1331,7 +1331,7 @@ public final void commitValue() {
}

/**
* If the field is currently being edited, this call will set text to the last commited value.
* If the field is currently being edited, this call will set text to the last committed value.
* @since JavaFX 8u40
*/
public final void cancelEdit() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
* </code></pre>
*
* <p>In this example, there is a list of Map instances, where each Map instance
* representsa single row in the TableView. The "firstName" string is used as a
* represents a single row in the TableView. The "firstName" string is used as a
* key into this map, and the value corresponding to this key is returned, if
* one exists. If the value is an {@link ObservableValue}, then this is returned
* directly, otherwise the value is wrapped in a {@link ReadOnlyObjectWrapper}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
* Skin the responsibility of computing the min, max, and pref sizes of the
* Control, the baseline offset, and hit testing (containment and
* intersection). It is also the responsibility of the Skin, or a delegate of
* the Skin, to implement and repond to all relevant key
* the Skin, to implement and respond to all relevant key
* events which occur on the Control when it contains the focus.</p>
*
* <h2>Control</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ protected final boolean isForwardBias() {
*
* @param unit the unit of text to move by.
* @param dir the direction of movement.
* @param select whether to extends the selection to the new posititon.
* @param select whether to extends the selection to the new position.
*/
public abstract void moveCaret(TextUnit unit, Direction dir, boolean select);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public VirtualContainerBase(final C control) {
* Create the virtualized container that handles the layout and scrolling of
* all the cells. This enables skin subclasses to provide
* a custom {@link VirtualFlow} implementation.
* If not overridden, this method intantiates a default VirtualFlow instance.
* If not overridden, this method instantiates a default VirtualFlow instance.
* @return newly created VirtualFlow instance
* @since 10
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2125,7 +2125,7 @@ public void invoke(Object... params) {
public static final String JAVAFX_VERSION;

/**
* Contains the current fx namepsace version.
* Contains the current fx namespace version.
* @since JavaFX 8.0
*/
public static final String FX_NAMESPACE_VERSION = "1";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ <h3><a id="intronaming">Naming Conventions</a></h3>
lower case, with compound words separated by hyphens. The convention is
therefore to take JavaFX class names and form their corresponding CSS
style&#8209;class name by separating the compound words with hyphens and
convering the letters to all lower case. For example, the JavaFX
converting the letters to all lower case. For example, the JavaFX
ToggleButton class would have a style&#8209;class of "toggle-button". The
convention for mapping JavaFX variable names to CSS property names is
similar, with the addition of the "-fx-" prefix. For example, the
Expand Down Expand Up @@ -1521,7 +1521,7 @@ <h4>Looked-up Colors <span class="grammar" style="font-size: smaller;">&lt;looke
<p>With looked-up colors you can refer to any other color property that is
set on the current node or any of its parents. This is a very powerful
feature, as it allows a generic palette of colors to be specified on the
scene then used thoughout the application. If you want to change one of
scene then used throughout the application. If you want to change one of
those palette colors you can do so at any level in the scene tree and it
will affect that node and all its decendents. Looked-up colors are not
looked up until they are applied, so they are live and react to any style
Expand Down Expand Up @@ -2520,7 +2520,7 @@ <h4><a id="region">Region</a></h4>
[ , [<a href="#typesize" class="typelink">&lt;size&gt;</a>]{1,4} [ / [<a href="#typesize" class="typelink">&lt;size&gt;</a>]{1,4} ]? ]*
<td class="default">0 0 0 0</td>
<td>
<p>The same syntax and semenatics as CSS Backgrounds and Borders Module Level 3: <a href="http://www.w3.org/TR/css3-background/#the-border-radius">Curve Radii</a>
<p>The same syntax and semantics as CSS Backgrounds and Borders Module Level 3: <a href="http://www.w3.org/TR/css3-background/#the-border-radius">Curve Radii</a>
applies to -fx-background-radius. Note that JavaFX supports only the short-hand syntax.</p>
<p>Each comma-separated value or set of values in the series applies to the corresponding background color.</p>
</td>
Expand Down Expand Up @@ -2894,7 +2894,7 @@ <h4><a id="region">Region</a></h4>
<td class="value"><a href="#typesize" class="typelink">&lt;size&gt;</a></td>
<td class="default">-1</td>
<td>Percentage values are not useful since the actual value would be
computed from the width and/or height of the Regions's parent before
computed from the width and/or height of the Region's parent before
the parent is laid out.</td>
</tr>
<tr>
Expand Down Expand Up @@ -4352,7 +4352,7 @@ <h4>Pseudo-classes</h4>
<td>applies if the <strong>indeterminate</strong> variable is false</td>
</tr>
<tr>
<th class="propertyname" scope="row">indetermindate</th>
<th class="propertyname" scope="row">indeterminate</th>
<td>applies if the <strong>indeterminate</strong> variable is true</td>
</tr>
<tr>
Expand Down Expand Up @@ -4419,7 +4419,7 @@ <h4>Pseudo-classes</h4>
<td>applies if the <strong>indeterminate</strong> variable is false</td>
</tr>
<tr>
<th class="propertyname" scope="row">indetermindate</th>
<th class="propertyname" scope="row">indeterminate</th>
<td>applies if the <strong>indeterminate</strong> variable is true</td>
</tr>
<tr>
Expand Down Expand Up @@ -5599,7 +5599,7 @@ <h4><a id="treecell">TreeCell</a></h4>
<th class="propertyname" scope="row">-fx-indent</th>
<td class="value"><a href="#typesize" class="typelink">&lt;size&gt;</a></td>
<td>10</td>
<td>The amout of space to multiply by the treeItem.level to get the
<td>The amount of space to multiply by the treeItem.level to get the
left margin</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ public final ObjectProperty<Shape> pathProperty() {
public static enum OrientationType {

/**
* The targeted {@code node}'s rotation matrix stays unchange along the
* The targeted {@code node}'s rotation matrix stays unchanged along the
* geometric path.
*/
NONE,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public int getOrdinal() {
* {@code PseudoClass} state that it finds along the way.
* @param styleable the {@code Styleable} to match
* @param triggerStates a set of {@code PseudoClass} states
* @param depth depth of the {@code Node} heirarchy to look for
* @param depth depth of the {@code Node} hierarchy to look for
* @return {@code true} if this {@code Selector} and a set of {@code PseudoClass}
* applies to the given {@code Styleable}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,8 @@ private SizeUnits(boolean absolute) {
private final boolean absolute;

/**
* Gets wehther this {@code SizeUnits} value is absolute.
* @return whether value is absoulute
* Gets whether this {@code SizeUnits} value is absolute.
* @return whether value is absolute
*/
public boolean isAbsolute() {
return absolute;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
package javafx.print;

/**
* Class to decribe printing quality setting.
* Class to describe printing quality setting.
* @since JavaFX 8.0
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* When printing in a portrait orientation
* cross feed direction is usually x/horizontal resolution, and
* feed direction is usually y/horizontal resolution.
* On most printers these are the same value, but it is possuble
* On most printers these are the same value, but it is possible
* for them to be different.
* @since JavaFX 8.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ public enum PrintSides {
/**
* Two sided printing where the vertical edge of the paper is to be used
* for binding such as in a book. In PORTAIT mode printing, the
* vertical edge is usally the long edge but this is reversed if
* vertical edge is usually the long edge but this is reversed if
* LANDSCAPE printing is requested
*/
DUPLEX,

/**
* Two sided printing where the horizontal edge of the paper is to be used
* for binding such as in a notepad. In PORTAIT mode printing, the
* horizontal edge is usally the short edge but this is reversed if
* horizontal edge is usually the short edge but this is reversed if
* LANDSCAPE printing is requested
*/
TUMBLE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
* <li>Job creation
* <li>Job configuration based on supported printer capabilities
* <li>Page setup
* <li>Rendering of a node hierachy to a page.
* <li>Rendering of a node hierarchy to a page.
* </ul>
* <p>
* Here ia a very simple example, which prints a single node.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public enum AccessibleAction {
/**
* Request that the node take focus. By default, a node will
* request focus using {@link javafx.scene.Node#requestFocus()}.
* Both JavaFX and the assisteve technology have the concept of
* Both JavaFX and the assistive technology have the concept of
* a focus node and most of the time, they are the same.
* In some cases, a control might want the JavaFX focus to remain
* on the parent, while the assistive technology focus is on the child.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ public enum AccessibleAttribute {
HORIZONTAL_SCROLLBAR(Node.class),

/**
* Returns true of the node is indeterminaite, otherwise false.
* Returns true of the node is indeterminate, otherwise false.
* <ul>
* <li>Used by: CheckBox and ProgressIndicator </li>
* <li>Needs notify: yes </li>
Expand Down
4 changes: 2 additions & 2 deletions modules/javafx.graphics/src/main/java/javafx/scene/Node.java
Original file line number Diff line number Diff line change
Expand Up @@ -2673,8 +2673,8 @@ protected Node() {}
* *
**************************************************************************/
/**
* Defines whether or not this node's layout will be managed by it's parent.
* If the node is managed, it's parent will factor the node's geometry
* Defines whether or not this node's layout will be managed by its parent.
* If the node is managed, its parent will factor the node's geometry
* into its own preferred size and {@link #layoutBoundsProperty layoutBounds}
* calculations and will lay it
* out during the scene's layout pass. If a managed node's layoutBounds
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -657,8 +657,8 @@ private String constructExceptionMessage(
* restored. An {@link IllegalArgumentException} is thrown in this case.
*
* <p>
* If this {@link Parent} node is attached to a {@link Scene} attached to a {@link Window}
* that is showning ({@link javafx.stage.Window#isShowing()}), then its
* If this {@link Parent} node is attached to a {@link Scene} attached to a {@link Window},
* that is, showing ({@link javafx.stage.Window#isShowing()}), then its
* list of children must only be modified on the JavaFX Application Thread.
* An {@link IllegalStateException} is thrown if this restriction is
* violated.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public final void clear() {
/**
* Gets the set of DataFormat types on this Clipboard instance which have
* associated data registered on the clipboard. This set will always
* be non-null and immutable. If the Clipboard is subsequently modifed,
* be non-null and immutable. If the Clipboard is subsequently modified,
* this returned set is not updated.
*
* @return A non-null immutable set of content types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
* <p>
* Drag and drop gesture can be started by calling {@code startDragAndDrop()}
* (on a node or scene) inside of a {@link MouseEvent#DRAG_DETECTED DRAG_DETECTED} event handler.
* The data to be transfered to drop target are placed to a {@code dragBoard}
* The data to be transferred to drop target are placed to a {@code dragBoard}
* at this moment.
* <p>
* Drag entered/exited events behave similarly to mouse entered/exited
Expand All @@ -70,7 +70,7 @@
* Inside a {@code DRAG_DETECTED} event handler, if the
* {@code startDragAndDrop()} method is called on a node or scene and a dragged
* data is made available to the returned {@code Dragboard}, the object on which
* {@code startDragAndDrop()} has been called is considred a gesture source
* {@code startDragAndDrop()} has been called is considered a gesture source
* and the drag and drop gesture is started. The {@code Dragboard} has system
* clipboard functionality but is specifically used for drag and drop data
* transfer.
Expand Down Expand Up @@ -133,7 +133,7 @@
* {@code DragBoard.getTransferModes()} (set of transfer modes supported by
* the gesture source) and {@code DragEvent.getTransferMode()} (default
* transfer mode issued by platform, driven by key modifiers) can be used.
* It is poosible to pass more transfer modes into the
* It is possible to pass more transfer modes into the
* {@code acceptTransferModes(TransferMode...)} method. In this case
* it makes the decision in behalf of the
* application (it chooses the default mode if it's supported by gesture source
Expand Down Expand Up @@ -238,7 +238,7 @@ public final class DragEvent extends InputEvent {
/**
* This event occurs when drag gesture exits a node. It's the
* bubbling variant, which is delivered also to all parents of the
* eixited node (unless it was consumed). When notifications about
* exited node (unless it was consumed). When notifications about
* exiting some of node's children are not desired,
* {@code DRAG_EXITED} event handler should be used.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Object getContentImpl(DataFormat dataFormat) {
}

/**
* Gets set of transport modes supported by source of this drag opeation.
* Gets set of transport modes supported by source of this drag operation.
* @return set of supported transfer modes
*/
public final Set<TransferMode> getTransferModes() {
Expand All @@ -73,7 +73,7 @@ static Dragboard createDragboard(TKClipboard peer) {

// PENDING_DOC_REVIEW
/**
* Sets the visual representation of data being transfered
* Sets the visual representation of data being transferred
* in a drag and drop gesture.
* Uses the given image for the drag view with the offsetX and offsetY
* specifying cursor position over the image.
Expand All @@ -92,7 +92,7 @@ public void setDragView(Image image, double offsetX, double offsetY) {
}

/**
* Sets the visual representation of data being transfered
* Sets the visual representation of data being transferred
* in a drag and drop gesture.
* This method should be called only when starting drag and drop operation
* in the DRAG_DETECTED handler, calling it at other times
Expand Down
Loading