mirror of
https://github.com/openjdk/jdk.git
synced 2026-04-18 10:50:23 +00:00
8025117: [cleanup] Eliminate doclint errors in javax/swing/text classes
Reviewed-by: alexsch
This commit is contained in:
parent
560d55440f
commit
cde6d64f60
@ -44,16 +44,16 @@ import java.security.PrivilegedAction;
|
||||
* {@code JLayer} is a universal decorator for Swing components
|
||||
* which enables you to implement various advanced painting effects as well as
|
||||
* receive notifications of all {@code AWTEvent}s generated within its borders.
|
||||
* <p/>
|
||||
* <p>
|
||||
* {@code JLayer} delegates the handling of painting and input events to a
|
||||
* {@link javax.swing.plaf.LayerUI} object, which performs the actual decoration.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The custom painting implemented in the {@code LayerUI} and events notification
|
||||
* work for the JLayer itself and all its subcomponents.
|
||||
* This combination enables you to enrich existing components
|
||||
* by adding new advanced functionality such as temporary locking of a hierarchy,
|
||||
* data tips for compound components, enhanced mouse scrolling etc and so on.
|
||||
* <p/>
|
||||
* <p>
|
||||
* {@code JLayer} is a good solution if you only need to do custom painting
|
||||
* over compound component or catch input events from its subcomponents.
|
||||
* <pre>
|
||||
@ -202,7 +202,7 @@ public final class JLayer<V extends Component>
|
||||
|
||||
/**
|
||||
* Returns the {@code JLayer}'s view component or {@code null}.
|
||||
* <br/>This is a bound property.
|
||||
* <br>This is a bound property.
|
||||
*
|
||||
* @return the {@code JLayer}'s view component
|
||||
* or {@code null} if none exists
|
||||
@ -215,7 +215,7 @@ public final class JLayer<V extends Component>
|
||||
|
||||
/**
|
||||
* Sets the {@code JLayer}'s view component, which can be {@code null}.
|
||||
* <br/>This is a bound property.
|
||||
* <br>This is a bound property.
|
||||
*
|
||||
* @param view the view component for this {@code JLayer}
|
||||
*
|
||||
@ -257,7 +257,7 @@ public final class JLayer<V extends Component>
|
||||
|
||||
/**
|
||||
* Returns the {@code JLayer}'s glassPane component or {@code null}.
|
||||
* <br/>This is a bound property.
|
||||
* <br>This is a bound property.
|
||||
*
|
||||
* @return the {@code JLayer}'s glassPane component
|
||||
* or {@code null} if none exists
|
||||
@ -270,7 +270,7 @@ public final class JLayer<V extends Component>
|
||||
|
||||
/**
|
||||
* Sets the {@code JLayer}'s glassPane component, which can be {@code null}.
|
||||
* <br/>This is a bound property.
|
||||
* <br>This is a bound property.
|
||||
*
|
||||
* @param glassPane the glassPane component of this {@code JLayer}
|
||||
*
|
||||
@ -309,7 +309,7 @@ public final class JLayer<V extends Component>
|
||||
/**
|
||||
* Sets the layout manager for this container. This method is
|
||||
* overridden to prevent the layout manager from being set.
|
||||
* <p/>Note: If {@code mgr} is non-{@code null}, this
|
||||
* <p>Note: If {@code mgr} is non-{@code null}, this
|
||||
* method will throw an exception as layout managers are not supported on
|
||||
* a {@code JLayer}.
|
||||
*
|
||||
@ -327,7 +327,7 @@ public final class JLayer<V extends Component>
|
||||
* of this component from becoming complex enough to inhibit
|
||||
* subclassing of {@code LayerUI} class. To create a {@code JLayer} with a border,
|
||||
* add it to a {@code JPanel} that has a border.
|
||||
* <p/>Note: If {@code border} is non-{@code null}, this
|
||||
* <p>Note: If {@code border} is non-{@code null}, this
|
||||
* method will throw an exception as borders are not supported on
|
||||
* a {@code JLayer}.
|
||||
*
|
||||
@ -471,11 +471,11 @@ public final class JLayer<V extends Component>
|
||||
* defined by the specified event mask parameter
|
||||
* to be delivered to the
|
||||
* {@link LayerUI#eventDispatched(AWTEvent, JLayer)} method.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Events are delivered provided that {@code LayerUI} is set
|
||||
* for this {@code JLayer} and the {@code JLayer}
|
||||
* is displayable.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The following example shows how to correctly use this method
|
||||
* in the {@code LayerUI} implementations:
|
||||
* <pre>
|
||||
@ -519,10 +519,10 @@ public final class JLayer<V extends Component>
|
||||
/**
|
||||
* Returns the bitmap of event mask to receive by this {@code JLayer}
|
||||
* and its {@code LayerUI}.
|
||||
* <p/>
|
||||
* <p>
|
||||
* It means that {@link javax.swing.plaf.LayerUI#eventDispatched(AWTEvent, JLayer)} method
|
||||
* will only receive events that match the event mask.
|
||||
* <p/>
|
||||
* <p>
|
||||
* By default {@code JLayer} receives no events.
|
||||
*
|
||||
* @return the bitmask of event types to receive for this {@code JLayer}
|
||||
@ -543,7 +543,7 @@ public final class JLayer<V extends Component>
|
||||
|
||||
/**
|
||||
* Returns the preferred size of the viewport for a view component.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the view component of this layer implements {@link Scrollable}, this method delegates its
|
||||
* implementation to the view component.
|
||||
*
|
||||
@ -562,7 +562,7 @@ public final class JLayer<V extends Component>
|
||||
* Returns a scroll increment, which is required for components
|
||||
* that display logical rows or columns in order to completely expose
|
||||
* one block of rows or columns, depending on the value of orientation.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the view component of this layer implements {@link Scrollable}, this method delegates its
|
||||
* implementation to the view component.
|
||||
*
|
||||
@ -584,7 +584,7 @@ public final class JLayer<V extends Component>
|
||||
* Returns {@code false} to indicate that the height of the viewport does not
|
||||
* determine the height of the layer, unless the preferred height
|
||||
* of the layer is smaller than the height of the viewport.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the view component of this layer implements {@link Scrollable}, this method delegates its
|
||||
* implementation to the view component.
|
||||
*
|
||||
@ -603,7 +603,7 @@ public final class JLayer<V extends Component>
|
||||
* Returns {@code false} to indicate that the width of the viewport does not
|
||||
* determine the width of the layer, unless the preferred width
|
||||
* of the layer is smaller than the width of the viewport.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the view component of this layer implements {@link Scrollable}, this method delegates its
|
||||
* implementation to the view component.
|
||||
*
|
||||
@ -624,10 +624,10 @@ public final class JLayer<V extends Component>
|
||||
* one new row or column, depending on the value of orientation.
|
||||
* Ideally, components should handle a partially exposed row or column
|
||||
* by returning the distance required to completely expose the item.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Scrolling containers, like {@code JScrollPane}, will use this method
|
||||
* each time the user requests a unit scroll.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the view component of this layer implements {@link Scrollable}, this method delegates its
|
||||
* implementation to the view component.
|
||||
*
|
||||
|
||||
@ -357,7 +357,7 @@ public abstract class RowFilter<M,I> {
|
||||
*
|
||||
* @param index the index of the value to get
|
||||
* @return value at the specified index
|
||||
* @throws <code>IndexOutOfBoundsException</code> if index < 0 or
|
||||
* @throws IndexOutOfBoundsException if index < 0 or
|
||||
* >= getValueCount
|
||||
*/
|
||||
public abstract Object getValue(int index);
|
||||
@ -376,7 +376,7 @@ public abstract class RowFilter<M,I> {
|
||||
*
|
||||
* @param index the index of the value to get
|
||||
* @return {@code non-null} string at the specified index
|
||||
* @throws <code>IndexOutOfBoundsException</code> if index < 0 ||
|
||||
* @throws IndexOutOfBoundsException if index < 0 ||
|
||||
* >= getValueCount
|
||||
*/
|
||||
public String getStringValue(int index) {
|
||||
|
||||
@ -42,7 +42,7 @@ public abstract class TextUI extends ComponentUI
|
||||
* Converts the given location in the model to a place in
|
||||
* the view coordinate system.
|
||||
*
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @return the coordinates as a rectangle
|
||||
* @exception BadLocationException if the given position does not
|
||||
* represent a valid location in the associated document
|
||||
@ -53,7 +53,7 @@ public abstract class TextUI extends ComponentUI
|
||||
* Converts the given location in the model to a place in
|
||||
* the view coordinate system.
|
||||
*
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @return the coordinates as a rectangle
|
||||
* @exception BadLocationException if the given position does not
|
||||
* represent a valid location in the associated document
|
||||
@ -67,7 +67,7 @@ public abstract class TextUI extends ComponentUI
|
||||
* @param pt the location in the view to translate. This
|
||||
* should be in the same coordinate system as the mouse
|
||||
* events.
|
||||
* @return the offset from the start of the document >= 0
|
||||
* @return the offset from the start of the document >= 0
|
||||
*/
|
||||
public abstract int viewToModel(JTextComponent t, Point pt);
|
||||
|
||||
@ -84,7 +84,7 @@ public abstract class TextUI extends ComponentUI
|
||||
* character in the model
|
||||
*
|
||||
* @return the location within the model that best represents the
|
||||
* given point in the view >= 0
|
||||
* given point in the view >= 0
|
||||
*/
|
||||
public abstract int viewToModel(JTextComponent t, Point pt,
|
||||
Position.Bias[] biasReturn);
|
||||
@ -96,7 +96,7 @@ public abstract class TextUI extends ComponentUI
|
||||
* might not allow access to some of the locations in the model.
|
||||
*
|
||||
* @param t the text component for which this UI is installed
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param b the bias for the position
|
||||
* @param direction the direction from the current position that can
|
||||
* be thought of as the arrow keys typically found on a keyboard.
|
||||
@ -117,8 +117,8 @@ public abstract class TextUI extends ComponentUI
|
||||
* Causes the portion of the view responsible for the
|
||||
* given part of the model to be repainted.
|
||||
*
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
*/
|
||||
public abstract void damageRange(JTextComponent t, int p0, int p1);
|
||||
|
||||
@ -126,8 +126,8 @@ public abstract class TextUI extends ComponentUI
|
||||
* Causes the portion of the view responsible for the
|
||||
* given part of the model to be repainted.
|
||||
*
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
*/
|
||||
public abstract void damageRange(JTextComponent t, int p0, int p1,
|
||||
Position.Bias firstBias,
|
||||
|
||||
@ -1012,7 +1012,7 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* this translation to be computed.
|
||||
*
|
||||
* @param tc the text component for which this UI is installed
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @return the coordinates as a rectangle, null if the model is not painted
|
||||
* @exception BadLocationException if the given position does not
|
||||
* represent a valid location in the associated document
|
||||
@ -1029,7 +1029,7 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* this translation to be computed.
|
||||
*
|
||||
* @param tc the text component for which this UI is installed
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @param pos the local location in the model to translate >= 0
|
||||
* @return the coordinates as a rectangle, null if the model is not painted
|
||||
* @exception BadLocationException if the given position does not
|
||||
* represent a valid location in the associated document
|
||||
@ -1066,7 +1066,7 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* @param tc the text component for which this UI is installed
|
||||
* @param pt the location in the view to translate. This
|
||||
* should be in the same coordinate system as the mouse events.
|
||||
* @return the offset from the start of the document >= 0,
|
||||
* @return the offset from the start of the document >= 0,
|
||||
* -1 if not painted
|
||||
* @see TextUI#viewToModel
|
||||
*/
|
||||
@ -1083,7 +1083,7 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* @param tc the text component for which this UI is installed
|
||||
* @param pt the location in the view to translate. This
|
||||
* should be in the same coordinate system as the mouse events.
|
||||
* @return the offset from the start of the document >= 0,
|
||||
* @return the offset from the start of the document >= 0,
|
||||
* -1 if the component doesn't yet have a positive size.
|
||||
* @see TextUI#viewToModel
|
||||
*/
|
||||
@ -1141,8 +1141,8 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* the view is not currently painted.
|
||||
*
|
||||
* @param tc the text component for which this UI is installed
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @see TextUI#damageRange
|
||||
*/
|
||||
public void damageRange(JTextComponent tc, int p0, int p1) {
|
||||
@ -1153,8 +1153,8 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* Causes the portion of the view responsible for the
|
||||
* given part of the model to be repainted.
|
||||
*
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
*/
|
||||
public void damageRange(JTextComponent t, int p0, int p1,
|
||||
Position.Bias p0Bias, Position.Bias p1Bias) {
|
||||
@ -1271,8 +1271,8 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* it is unable to represent the part of the element.
|
||||
*
|
||||
* @param elem the element
|
||||
* @param p0 the starting offset >= 0
|
||||
* @param p1 the ending offset >= p0
|
||||
* @param p0 the starting offset >= 0
|
||||
* @param p1 the ending offset >= p0
|
||||
* @return the view
|
||||
*/
|
||||
public View create(Element elem, int p0, int p1) {
|
||||
@ -1471,7 +1471,7 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* the model. This is implemented to return the index of the only
|
||||
* child.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @return index of the view representing the given position, or
|
||||
* -1 if no view represents that position
|
||||
* @since 1.3
|
||||
@ -1515,11 +1515,11 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param p0 the position to convert >= 0
|
||||
* @param p0 the position to convert >= 0
|
||||
* @param b0 the bias toward the previous character or the
|
||||
* next character represented by p0, in case the
|
||||
* position is a boundary of two views.
|
||||
* @param p1 the position to convert >= 0
|
||||
* @param p1 the position to convert >= 0
|
||||
* @param b1 the bias toward the previous character or the
|
||||
* next character represented by p1, in case the
|
||||
* position is a boundary of two views.
|
||||
@ -1561,7 +1561,7 @@ public abstract class BasicTextUI extends TextUI implements ViewFactory {
|
||||
* they might not be in the same order found in the model, or they just
|
||||
* might not allow access to some of the locations in the model.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param direction the direction from the current position that can
|
||||
* be thought of as the arrow keys typically found on a keyboard.
|
||||
|
||||
@ -71,7 +71,7 @@ public interface AttributeSet {
|
||||
* This interface is the type signature that is expected
|
||||
* to be present on any attribute key that contributes to
|
||||
* character level presentation. This would be any attribute
|
||||
* that applies to a so-called <term>run</term> of
|
||||
* that applies to a so-called <i>run</i> of
|
||||
* style.
|
||||
*/
|
||||
public interface CharacterAttribute {
|
||||
|
||||
@ -46,7 +46,7 @@ public class BadLocationException extends Exception
|
||||
* Creates a new BadLocationException object.
|
||||
*
|
||||
* @param s a string indicating what was wrong with the arguments
|
||||
* @param offs offset within the document that was requested >= 0
|
||||
* @param offs offset within the document that was requested >= 0
|
||||
*/
|
||||
public BadLocationException(String s, int offs) {
|
||||
super(s);
|
||||
@ -56,7 +56,7 @@ public class BadLocationException extends Exception
|
||||
/**
|
||||
* Returns the offset into the document that was not legal.
|
||||
*
|
||||
* @return the offset >= 0
|
||||
* @return the offset >= 0
|
||||
*/
|
||||
public int offsetRequested() {
|
||||
return offs;
|
||||
|
||||
@ -154,7 +154,7 @@ public class BoxView extends CompositeView {
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param alloc the allocated region to paint into
|
||||
* @param index the child index, >= 0 && < getViewCount()
|
||||
* @param index the child index, >= 0 && < getViewCount()
|
||||
*/
|
||||
protected void paintChild(Graphics g, Rectangle alloc, int index) {
|
||||
View child = getView(index);
|
||||
@ -170,9 +170,9 @@ public class BoxView extends CompositeView {
|
||||
* will have an offset and span of 0.
|
||||
*
|
||||
* @param index the starting index into the child views to insert
|
||||
* the new views; this should be a value >= 0 and <= getViewCount
|
||||
* the new views; this should be a value >= 0 and <= getViewCount
|
||||
* @param length the number of existing child views to remove;
|
||||
* This should be a value >= 0 and <= (getViewCount() - offset)
|
||||
* This should be a value >= 0 and <= (getViewCount() - offset)
|
||||
* @param elems the child views to add; this value can be
|
||||
* <code>null</code>to indicate no children are being added
|
||||
* (useful to remove)
|
||||
@ -390,8 +390,8 @@ public class BoxView extends CompositeView {
|
||||
* information. This is implemented to call the
|
||||
* layout method with the sizes inside of the insets.
|
||||
*
|
||||
* @param width the width >= 0
|
||||
* @param height the height >= 0
|
||||
* @param width the width >= 0
|
||||
* @param height the height >= 0
|
||||
*/
|
||||
public void setSize(float width, float height) {
|
||||
layout(Math.max(0, (int)(width - getLeftInset() - getRightInset())),
|
||||
@ -442,7 +442,7 @@ public class BoxView extends CompositeView {
|
||||
* <code>null</code> if the layout is invalid,
|
||||
* otherwise the superclass behavior is executed.
|
||||
*
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param index the index of the child, >= 0 && > getViewCount()
|
||||
* @param a the allocation to this view
|
||||
* @return the allocation to the child; or <code>null</code>
|
||||
* if <code>a</code> is <code>null</code>;
|
||||
@ -469,7 +469,7 @@ public class BoxView extends CompositeView {
|
||||
* to the coordinate space of the view mapped to it. This makes
|
||||
* sure the allocation is valid before calling the superclass.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the bounding box of the given position
|
||||
* @exception BadLocationException if the given position does
|
||||
@ -488,11 +488,11 @@ public class BoxView extends CompositeView {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param x x coordinate of the view location to convert >= 0
|
||||
* @param y y coordinate of the view location to convert >= 0
|
||||
* @param x x coordinate of the view location to convert >= 0
|
||||
* @param y y coordinate of the view location to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the location within the model that best represents the
|
||||
* given point in the view >= 0
|
||||
* given point in the view >= 0
|
||||
* @see View#viewToModel
|
||||
*/
|
||||
public int viewToModel(float x, float y, Shape a, Position.Bias[] bias) {
|
||||
@ -513,7 +513,7 @@ public class BoxView extends CompositeView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the desired alignment >= 0.0f && <= 1.0f; this should
|
||||
* @return the desired alignment >= 0.0f && <= 1.0f; this should
|
||||
* be a value between 0.0 and 1.0 where 0 indicates alignment at the
|
||||
* origin and 1.0 indicates alignment to the full span
|
||||
* away from the origin; an alignment of 0.5 would be the
|
||||
@ -535,7 +535,7 @@ public class BoxView extends CompositeView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee;
|
||||
* the parent may choose to resize or break the view
|
||||
@ -558,7 +558,7 @@ public class BoxView extends CompositeView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee;
|
||||
* the parent may choose to resize or break the view
|
||||
@ -581,7 +581,7 @@ public class BoxView extends CompositeView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee;
|
||||
* the parent may choose to resize or break the view
|
||||
@ -613,8 +613,8 @@ public class BoxView extends CompositeView {
|
||||
/**
|
||||
* Determines if a point falls before an allocated region.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param innerAlloc the allocated region; this is the area
|
||||
* inside of the insets
|
||||
* @return true if the point lies before the region else false
|
||||
@ -630,8 +630,8 @@ public class BoxView extends CompositeView {
|
||||
/**
|
||||
* Determines if a point falls after an allocated region.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param innerAlloc the allocated region; this is the area
|
||||
* inside of the insets
|
||||
* @return true if the point lies after the region else false
|
||||
@ -647,8 +647,8 @@ public class BoxView extends CompositeView {
|
||||
/**
|
||||
* Fetches the child view at the given coordinates.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the parents inner allocation on entry, which should
|
||||
* be changed to the childs allocation on exit
|
||||
* @return the view
|
||||
@ -688,7 +688,7 @@ public class BoxView extends CompositeView {
|
||||
* Allocates a region for a child view.
|
||||
*
|
||||
* @param index the index of the child view to
|
||||
* allocate, >= 0 && < getViewCount()
|
||||
* allocate, >= 0 && < getViewCount()
|
||||
* @param alloc the allocated region
|
||||
*/
|
||||
protected void childAllocation(int index, Rectangle alloc) {
|
||||
@ -701,8 +701,8 @@ public class BoxView extends CompositeView {
|
||||
/**
|
||||
* Perform layout on the box
|
||||
*
|
||||
* @param width the width (inside of the insets) >= 0
|
||||
* @param height the height (inside of the insets) >= 0
|
||||
* @param width the width (inside of the insets) >= 0
|
||||
* @param height the height (inside of the insets) >= 0
|
||||
*/
|
||||
protected void layout(int width, int height) {
|
||||
setSpanOnAxis(X_AXIS, width);
|
||||
|
||||
@ -149,7 +149,7 @@ public interface Caret {
|
||||
* and how fast the caret blinks, commonly used as one
|
||||
* way to attract attention to the caret.
|
||||
*
|
||||
* @param rate the delay in milliseconds >= 0. If this is
|
||||
* @param rate the delay in milliseconds >=0. If this is
|
||||
* zero the caret will not blink.
|
||||
*/
|
||||
public void setBlinkRate(int rate);
|
||||
@ -159,7 +159,7 @@ public interface Caret {
|
||||
* and how fast the caret blinks, commonly used as one
|
||||
* way to attract attention to the caret.
|
||||
*
|
||||
* @return the delay in milliseconds >= 0. If this is
|
||||
* @return the delay in milliseconds >=0. If this is
|
||||
* zero the caret will not blink.
|
||||
*/
|
||||
public int getBlinkRate();
|
||||
@ -167,7 +167,7 @@ public interface Caret {
|
||||
/**
|
||||
* Fetches the current position of the caret.
|
||||
*
|
||||
* @return the position >= 0
|
||||
* @return the position >=0
|
||||
*/
|
||||
public int getDot();
|
||||
|
||||
@ -176,7 +176,7 @@ public interface Caret {
|
||||
* is a selection, the mark will not be the same as
|
||||
* the dot.
|
||||
*
|
||||
* @return the position >= 0
|
||||
* @return the position >=0
|
||||
*/
|
||||
public int getMark();
|
||||
|
||||
@ -197,7 +197,7 @@ public interface Caret {
|
||||
* leaving behind the mark. This is useful for
|
||||
* making selections.
|
||||
*
|
||||
* @param dot the new position to move the caret to >= 0
|
||||
* @param dot the new position to move the caret to >=0
|
||||
*/
|
||||
public void moveDot(int dot);
|
||||
|
||||
|
||||
@ -125,7 +125,7 @@ public class ComponentView extends View {
|
||||
* axis of interest.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >=0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
@ -153,7 +153,7 @@ public class ComponentView extends View {
|
||||
* axis of interest.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >=0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
@ -181,7 +181,7 @@ public class ComponentView extends View {
|
||||
* axis of interest.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >=0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
@ -319,7 +319,7 @@ public class ComponentView extends View {
|
||||
* Provides a mapping from the coordinate space of the model to
|
||||
* that of the view.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >=0
|
||||
* @param a the allocated region to render into
|
||||
* @return the bounding box of the given position is returned
|
||||
* @exception BadLocationException if the given position does not
|
||||
@ -344,8 +344,8 @@ public class ComponentView extends View {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >=0
|
||||
* @param y the Y coordinate >=0
|
||||
* @param a the allocated region to render into
|
||||
* @return the location within the model that best represents
|
||||
* the given point in the view
|
||||
|
||||
@ -143,7 +143,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Returns the number of child views of this view.
|
||||
*
|
||||
* @return the number of views >= 0
|
||||
* @return the number of views >= 0
|
||||
* @see #getView
|
||||
*/
|
||||
public int getViewCount() {
|
||||
@ -153,7 +153,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Returns the n-th view in this container.
|
||||
*
|
||||
* @param n the number of the desired view, >= 0 && < getViewCount()
|
||||
* @param n the number of the desired view, >= 0 && < getViewCount()
|
||||
* @return the view at index <code>n</code>
|
||||
*/
|
||||
public View getView(int n) {
|
||||
@ -169,9 +169,9 @@ public abstract class CompositeView extends View {
|
||||
* may be garbage collected.
|
||||
*
|
||||
* @param offset the starting index into the child views to insert
|
||||
* the new views; >= 0 and <= getViewCount
|
||||
* the new views; >= 0 and <= getViewCount
|
||||
* @param length the number of existing child views to remove;
|
||||
* this should be a value >= 0 and <= (getViewCount() - offset)
|
||||
* this should be a value >= 0 and <= (getViewCount() - offset)
|
||||
* @param views the child views to add; this value can be
|
||||
* <code>null</code>
|
||||
* to indicate no children are being added (useful to remove)
|
||||
@ -223,7 +223,7 @@ public abstract class CompositeView extends View {
|
||||
* render into. This enables finding out where various views
|
||||
* are located.
|
||||
*
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param a the allocation to this view
|
||||
* @return the allocation to the child
|
||||
*/
|
||||
@ -237,7 +237,7 @@ public abstract class CompositeView extends View {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param b a bias value of either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code>
|
||||
@ -280,13 +280,13 @@ public abstract class CompositeView extends View {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param p0 the position to convert >= 0
|
||||
* @param p0 the position to convert >= 0
|
||||
* @param b0 the bias toward the previous character or the
|
||||
* next character represented by p0, in case the
|
||||
* position is a boundary of two views; either
|
||||
* <code>Position.Bias.Forward</code> or
|
||||
* <code>Position.Bias.Backward</code>
|
||||
* @param p1 the position to convert >= 0
|
||||
* @param p1 the position to convert >= 0
|
||||
* @param b1 the bias toward the previous character or the
|
||||
* next character represented by p1, in case the
|
||||
* position is a boundary of two views
|
||||
@ -378,13 +378,13 @@ public abstract class CompositeView extends View {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param x x coordinate of the view location to convert >= 0
|
||||
* @param y y coordinate of the view location to convert >= 0
|
||||
* @param x x coordinate of the view location to convert >= 0
|
||||
* @param y y coordinate of the view location to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param bias either <code>Position.Bias.Forward</code> or
|
||||
* <code>Position.Bias.Backward</code>
|
||||
* @return the location within the model that best represents the
|
||||
* given point in the view >= 0
|
||||
* given point in the view >= 0
|
||||
* @see View#viewToModel
|
||||
*/
|
||||
public int viewToModel(float x, float y, Shape a, Position.Bias[] bias) {
|
||||
@ -436,7 +436,7 @@ public abstract class CompositeView extends View {
|
||||
* This is a convenience method for {@link #getNextNorthSouthVisualPositionFrom}
|
||||
* and {@link #getNextEastWestVisualPositionFrom}.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param b a bias value of either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code>
|
||||
* @param a the allocated region to render into
|
||||
@ -484,7 +484,7 @@ public abstract class CompositeView extends View {
|
||||
* <code>getViewIndexByPosition</code>
|
||||
* method for backward compatibility.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @return index of the view representing the given position, or
|
||||
* -1 if no view represents that position
|
||||
* @since 1.3
|
||||
@ -505,8 +505,8 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Tests whether a point lies before the rectangle range.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the rectangle
|
||||
* @return true if the point is before the specified range
|
||||
*/
|
||||
@ -515,8 +515,8 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Tests whether a point lies after the rectangle range.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the rectangle
|
||||
* @return true if the point is after the specified range
|
||||
*/
|
||||
@ -525,8 +525,8 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Fetches the child view at the given coordinates.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the parent's allocation on entry, which should
|
||||
* be changed to the child's allocation on exit
|
||||
* @return the child view
|
||||
@ -536,7 +536,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Returns the allocation for a given child.
|
||||
*
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param a the allocation to the interior of the box on entry,
|
||||
* and the allocation of the child view at the index on exit.
|
||||
*/
|
||||
@ -547,7 +547,7 @@ public abstract class CompositeView extends View {
|
||||
* the model. This is implemented to fetch the view in the case
|
||||
* where there is a child view for each child element.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @param a the allocation to the interior of the box on entry,
|
||||
* and the allocation of the view containing the position on exit
|
||||
* @return the view representing the given position, or
|
||||
@ -570,7 +570,7 @@ public abstract class CompositeView extends View {
|
||||
* the model. This is implemented to fetch the view in the case
|
||||
* where there is a child view for each child element.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @return index of the view representing the given position, or
|
||||
* -1 if no view represents that position
|
||||
*/
|
||||
@ -639,10 +639,10 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Sets the insets for the view.
|
||||
*
|
||||
* @param top the top inset >= 0
|
||||
* @param left the left inset >= 0
|
||||
* @param bottom the bottom inset >= 0
|
||||
* @param right the right inset >= 0
|
||||
* @param top the top inset >= 0
|
||||
* @param left the left inset >= 0
|
||||
* @param bottom the bottom inset >= 0
|
||||
* @param right the right inset >= 0
|
||||
*/
|
||||
protected void setInsets(short top, short left, short bottom, short right) {
|
||||
this.top = top;
|
||||
@ -654,7 +654,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Gets the left inset.
|
||||
*
|
||||
* @return the inset >= 0
|
||||
* @return the inset >= 0
|
||||
*/
|
||||
protected short getLeftInset() {
|
||||
return left;
|
||||
@ -663,7 +663,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Gets the right inset.
|
||||
*
|
||||
* @return the inset >= 0
|
||||
* @return the inset >= 0
|
||||
*/
|
||||
protected short getRightInset() {
|
||||
return right;
|
||||
@ -672,7 +672,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Gets the top inset.
|
||||
*
|
||||
* @return the inset >= 0
|
||||
* @return the inset >= 0
|
||||
*/
|
||||
protected short getTopInset() {
|
||||
return top;
|
||||
@ -681,7 +681,7 @@ public abstract class CompositeView extends View {
|
||||
/**
|
||||
* Gets the bottom inset.
|
||||
*
|
||||
* @return the inset >= 0
|
||||
* @return the inset >= 0
|
||||
*/
|
||||
protected short getBottomInset() {
|
||||
return bottom;
|
||||
@ -691,7 +691,7 @@ public abstract class CompositeView extends View {
|
||||
* Returns the next visual position for the cursor, in either the
|
||||
* north or south direction.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param b a bias value of either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code>
|
||||
* @param a the allocated region to render into
|
||||
@ -723,7 +723,7 @@ public abstract class CompositeView extends View {
|
||||
* Returns the next visual position for the cursor, in either the
|
||||
* east or west direction.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param b a bias value of either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code>
|
||||
* @param a the allocated region to render into
|
||||
|
||||
@ -140,7 +140,7 @@ public class DefaultEditorKit extends EditorKit {
|
||||
* @param in The stream to read from
|
||||
* @param doc The destination for the insertion.
|
||||
* @param pos The location in the document to place the
|
||||
* content >= 0.
|
||||
* content >=0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
@ -158,8 +158,8 @@ public class DefaultEditorKit extends EditorKit {
|
||||
* @param out The stream to write to
|
||||
* @param doc The source for the write.
|
||||
* @param pos The location in the document to fetch the
|
||||
* content >= 0.
|
||||
* @param len The amount to write out >= 0.
|
||||
* content >=0.
|
||||
* @param len The amount to write out >=0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
@ -191,7 +191,7 @@ public class DefaultEditorKit extends EditorKit {
|
||||
* @param in The stream to read from
|
||||
* @param doc The destination for the insertion.
|
||||
* @param pos The location in the document to place the
|
||||
* content >= 0.
|
||||
* content >=0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
@ -300,8 +300,8 @@ public class DefaultEditorKit extends EditorKit {
|
||||
* @param out The stream to write to
|
||||
* @param doc The source for the write.
|
||||
* @param pos The location in the document to fetch the
|
||||
* content from >= 0.
|
||||
* @param len The amount to write out >= 0.
|
||||
* content from >=0.
|
||||
* @param len The amount to write out >=0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos is not within 0 and
|
||||
* the length of the document.
|
||||
|
||||
@ -105,8 +105,8 @@ public class DefaultHighlighter extends LayeredHighlighter {
|
||||
* Adds a highlight to the view. Returns a tag that can be used
|
||||
* to refer to the highlight.
|
||||
*
|
||||
* @param p0 the start offset of the range to highlight >= 0
|
||||
* @param p1 the end offset of the range to highlight >= p0
|
||||
* @param p0 the start offset of the range to highlight >= 0
|
||||
* @param p1 the end offset of the range to highlight >= p0
|
||||
* @param p the painter to use to actually render the highlight
|
||||
* @return an object that can be used as a tag
|
||||
* to refer to the highlight
|
||||
@ -220,8 +220,8 @@ public class DefaultHighlighter extends LayeredHighlighter {
|
||||
* Changes a highlight.
|
||||
*
|
||||
* @param tag the highlight tag
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @exception BadLocationException if the specified location is invalid
|
||||
*/
|
||||
public void changeHighlight(Object tag, int p0, int p1) throws BadLocationException {
|
||||
@ -395,8 +395,8 @@ public class DefaultHighlighter extends LayeredHighlighter {
|
||||
* Paints a highlight.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param offs0 the starting model offset >= 0
|
||||
* @param offs1 the ending model offset >= offs1
|
||||
* @param offs0 the starting model offset >= 0
|
||||
* @param offs1 the ending model offset >= offs1
|
||||
* @param bounds the bounding box for the highlight
|
||||
* @param c the editor
|
||||
*/
|
||||
@ -441,8 +441,8 @@ public class DefaultHighlighter extends LayeredHighlighter {
|
||||
* Paints a portion of a highlight.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param offs0 the starting model offset >= 0
|
||||
* @param offs1 the ending model offset >= offs1
|
||||
* @param offs0 the starting model offset >= 0
|
||||
* @param offs1 the ending model offset >= offs1
|
||||
* @param bounds the bounding box of the view, which is not
|
||||
* necessarily the region to paint.
|
||||
* @param c the editor
|
||||
|
||||
@ -176,7 +176,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
|
||||
* in Swing</A> for more information.
|
||||
*
|
||||
* @param offset the starting offset >= 0
|
||||
* @param offset the starting offset >= 0
|
||||
* @param data the element data
|
||||
* @exception BadLocationException for an invalid starting offset
|
||||
*/
|
||||
@ -429,7 +429,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
|
||||
* in Swing</A> for more information.
|
||||
*
|
||||
* @param pos the offset from the start of the document >= 0
|
||||
* @param pos the offset from the start of the document >= 0
|
||||
* @param s the logical style to assign to the paragraph, null if none
|
||||
*/
|
||||
public void setLogicalStyle(int pos, Style s) {
|
||||
@ -458,7 +458,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* represented by the given position.
|
||||
*
|
||||
* @param p the location to translate to a paragraph
|
||||
* and determine the logical style assigned >= 0. This
|
||||
* and determine the logical style assigned >= 0. This
|
||||
* is an offset from the start of the document.
|
||||
* @return the style, null if none
|
||||
*/
|
||||
@ -486,8 +486,8 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
|
||||
* in Swing</A> for more information.
|
||||
*
|
||||
* @param offset the offset in the document >= 0
|
||||
* @param length the length >= 0
|
||||
* @param offset the offset in the document >= 0
|
||||
* @param length the length >= 0
|
||||
* @param s the attributes
|
||||
* @param replace true if the previous attributes should be replaced
|
||||
* before setting the new attributes
|
||||
@ -539,8 +539,8 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
|
||||
* in Swing</A> for more information.
|
||||
*
|
||||
* @param offset the offset into the paragraph >= 0
|
||||
* @param length the number of characters affected >= 0
|
||||
* @param offset the offset into the paragraph >= 0
|
||||
* @param length the number of characters affected >= 0
|
||||
* @param s the attributes
|
||||
* @param replace whether to replace existing attributes, or merge them
|
||||
*/
|
||||
@ -589,7 +589,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* A paragraph consists of at least one child Element, which is usually
|
||||
* a leaf.
|
||||
*
|
||||
* @param pos the starting offset >= 0
|
||||
* @param pos the starting offset >= 0
|
||||
* @return the element
|
||||
*/
|
||||
public Element getParagraphElement(int pos) {
|
||||
@ -606,7 +606,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
/**
|
||||
* Gets a character element based on a position.
|
||||
*
|
||||
* @param pos the position in the document >= 0
|
||||
* @param pos the position in the document >= 0
|
||||
* @return the element
|
||||
*/
|
||||
public Element getCharacterElement(int pos) {
|
||||
@ -1233,7 +1233,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* @param a the attributes for the element
|
||||
* @param type the type of the element (StartTagType, EndTagType,
|
||||
* ContentType)
|
||||
* @param len the length >= 0
|
||||
* @param len the length >= 0
|
||||
*/
|
||||
public ElementSpec(AttributeSet a, short type, int len) {
|
||||
this(a, type, null, 0, len);
|
||||
@ -1247,8 +1247,8 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
* @param type the type of the element (StartTagType, EndTagType,
|
||||
* ContentType)
|
||||
* @param txt the text for the element
|
||||
* @param offs the offset into the text >= 0
|
||||
* @param len the length of the text >= 0
|
||||
* @param offs the offset into the text >= 0
|
||||
* @param len the length of the text >= 0
|
||||
*/
|
||||
public ElementSpec(AttributeSet a, short type, char[] txt,
|
||||
int offs, int len) {
|
||||
@ -1321,7 +1321,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
/**
|
||||
* Gets the starting offset.
|
||||
*
|
||||
* @return the offset >= 0
|
||||
* @return the offset >= 0
|
||||
*/
|
||||
public int getOffset() {
|
||||
return offs;
|
||||
@ -1330,7 +1330,7 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
/**
|
||||
* Gets the length.
|
||||
*
|
||||
* @return the length >= 0
|
||||
* @return the length >= 0
|
||||
*/
|
||||
public int getLength() {
|
||||
return len;
|
||||
@ -1420,8 +1420,8 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
/**
|
||||
* Inserts new content.
|
||||
*
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param data the data to insert
|
||||
* @param de the event capturing this edit
|
||||
*/
|
||||
@ -1500,8 +1500,8 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
/**
|
||||
* Removes content.
|
||||
*
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param de the event capturing this edit
|
||||
*/
|
||||
public void remove(int offset, int length, DefaultDocumentEvent de) {
|
||||
@ -1513,8 +1513,8 @@ public class DefaultStyledDocument extends AbstractDocument implements StyledDoc
|
||||
/**
|
||||
* Changes content.
|
||||
*
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param de the event capturing this edit
|
||||
*/
|
||||
public void change(int offset, int length, DefaultDocumentEvent de) {
|
||||
|
||||
@ -58,9 +58,9 @@ import javax.swing.event.*;
|
||||
* <p>The following methods give access to the character data
|
||||
* that makes up the content.
|
||||
* <ul>
|
||||
* <li><a href="#getLength()">getLength()</a>
|
||||
* <li><a href="#getText(int, int)">getText(int, int)</a>
|
||||
* <li><a href="#getText(int, int, javax.swing.text.Segment)">getText(int, int, Segment)</a>
|
||||
* <li>{@link #getLength()}
|
||||
* <li>{@link #getText(int, int)}
|
||||
* <li>{@link #getText(int, int, javax.swing.text.Segment)}
|
||||
* </ul>
|
||||
* <p><b><font size=+1>Structure</font></b>
|
||||
* <p>
|
||||
@ -79,8 +79,8 @@ import javax.swing.event.*;
|
||||
* <a href="AttributeSet.html">AttributeSet</a> interface.
|
||||
* <p>The following methods give access to the document structure.
|
||||
* <ul>
|
||||
* <li><a href="#getDefaultRootElement()">getDefaultRootElement</a>
|
||||
* <li><a href="#getRootElements()">getRootElements</a>
|
||||
* <li>{@link #getDefaultRootElement()}
|
||||
* <li>{@link #getRootElements()}
|
||||
* </ul>
|
||||
*
|
||||
* <p><b><font size=+1>Mutations</font></b>
|
||||
@ -93,9 +93,9 @@ import javax.swing.event.*;
|
||||
* <p>The following methods are related to mutation of the
|
||||
* document content:
|
||||
* <ul>
|
||||
* <li><a href="#insertString(int, java.lang.String, javax.swing.text.AttributeSet)">insertString(int, String, AttributeSet)</a>
|
||||
* <li><a href="#remove(int, int)">remove(int, int)</a>
|
||||
* <li><a href="#createPosition(int)">createPosition(int)</a>
|
||||
* <li>{@link #insertString(int, java.lang.String, javax.swing.text.AttributeSet)}
|
||||
* <li>{@link #remove(int, int)}
|
||||
* <li>{@link #createPosition(int)}
|
||||
* </ul>
|
||||
*
|
||||
* <p><b><font size=+1>Notification</font></b>
|
||||
@ -161,8 +161,8 @@ import javax.swing.event.*;
|
||||
* and the <a href="#TitleProperty">TitleProperty</a>, which can be used to
|
||||
* name the <code>Document</code>. The methods related to the properties are:
|
||||
* <ul>
|
||||
* <li><a href="#getProperty(java.lang.Object)">getProperty(Object)</a>
|
||||
* <li><a href="#putProperty(java.lang.Object, java.lang.Object)">putProperty(Object, Object)</a>
|
||||
* <li>{@link #getProperty(java.lang.Object)}
|
||||
* <li>{@link #putProperty(java.lang.Object, java.lang.Object)}
|
||||
* </ul>
|
||||
*
|
||||
* <p>For more information on the <code>Document</code> class, see
|
||||
|
||||
@ -68,8 +68,8 @@ public class DocumentFilter {
|
||||
* necessary.
|
||||
*
|
||||
* @param fb FilterBypass that can be used to mutate Document
|
||||
* @param offset the offset from the beginning >= 0
|
||||
* @param length the number of characters to remove >= 0
|
||||
* @param offset the offset from the beginning >= 0
|
||||
* @param length the number of characters to remove >= 0
|
||||
* @exception BadLocationException some portion of the removal range
|
||||
* was not a valid part of the document. The location in the exception
|
||||
* is the first bad position encountered.
|
||||
@ -86,7 +86,7 @@ public class DocumentFilter {
|
||||
* necessary, or call directly into the FilterBypass.
|
||||
*
|
||||
* @param fb FilterBypass that can be used to mutate Document
|
||||
* @param offset the offset into the document to insert the content >= 0.
|
||||
* @param offset the offset into the document to insert the content >= 0.
|
||||
* All positions that track change at or after the given location
|
||||
* will move.
|
||||
* @param string the string to insert
|
||||
@ -141,8 +141,8 @@ public class DocumentFilter {
|
||||
* Removes the specified region of text, bypassing the
|
||||
* DocumentFilter.
|
||||
*
|
||||
* @param offset the offset from the beginning >= 0
|
||||
* @param length the number of characters to remove >= 0
|
||||
* @param offset the offset from the beginning >= 0
|
||||
* @param length the number of characters to remove >= 0
|
||||
* @exception BadLocationException some portion of the removal range
|
||||
* was not a valid part of the document. The location in the
|
||||
* exception is the first bad position encountered.
|
||||
@ -154,7 +154,7 @@ public class DocumentFilter {
|
||||
* Inserts the specified text, bypassing the
|
||||
* DocumentFilter.
|
||||
* @param offset the offset into the document to insert the
|
||||
* content >= 0. All positions that track change at or after the
|
||||
* content >= 0. All positions that track change at or after the
|
||||
* given location will move.
|
||||
* @param string the string to insert
|
||||
* @param attr the attributes to associate with the inserted
|
||||
|
||||
@ -55,7 +55,7 @@ public abstract class EditorKit implements Cloneable, Serializable {
|
||||
|
||||
/**
|
||||
* Creates a copy of the editor kit. This is implemented
|
||||
* to use Object.clone</em>. If the kit cannot be cloned,
|
||||
* to use <code>Object.clone()</code>. If the kit cannot be cloned,
|
||||
* null is returned.
|
||||
*
|
||||
* @return the copy
|
||||
@ -139,7 +139,7 @@ public abstract class EditorKit implements Cloneable, Serializable {
|
||||
* @param in The stream to read from
|
||||
* @param doc The destination for the insertion.
|
||||
* @param pos The location in the document to place the
|
||||
* content >= 0.
|
||||
* content >= 0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
@ -154,8 +154,8 @@ public abstract class EditorKit implements Cloneable, Serializable {
|
||||
* @param out The stream to write to
|
||||
* @param doc The source for the write.
|
||||
* @param pos The location in the document to fetch the
|
||||
* content from >= 0.
|
||||
* @param len The amount to write out >= 0.
|
||||
* content from >= 0.
|
||||
* @param len The amount to write out >= 0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
@ -176,7 +176,7 @@ public abstract class EditorKit implements Cloneable, Serializable {
|
||||
* @param in The stream to read from
|
||||
* @param doc The destination for the insertion.
|
||||
* @param pos The location in the document to place the
|
||||
* content >= 0.
|
||||
* content >= 0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
@ -196,8 +196,8 @@ public abstract class EditorKit implements Cloneable, Serializable {
|
||||
* @param out The stream to write to
|
||||
* @param doc The source for the write.
|
||||
* @param pos The location in the document to fetch the
|
||||
* content >= 0.
|
||||
* @param len The amount to write out >= 0.
|
||||
* content >= 0.
|
||||
* @param len The amount to write out >= 0.
|
||||
* @exception IOException on any I/O error
|
||||
* @exception BadLocationException if pos represents an invalid
|
||||
* location within the document.
|
||||
|
||||
@ -200,7 +200,7 @@ public class FieldView extends PlainView {
|
||||
* axis.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
@ -241,7 +241,7 @@ public class FieldView extends PlainView {
|
||||
* given axis. A value of 0 or less is not resizable.
|
||||
*
|
||||
* @param axis View.X_AXIS or View.Y_AXIS
|
||||
* @return the weight -> 1 for View.X_AXIS, else 0
|
||||
* @return the weight -> 1 for View.X_AXIS, else 0
|
||||
*/
|
||||
public int getResizeWeight(int axis) {
|
||||
if (axis == View.X_AXIS) {
|
||||
@ -254,7 +254,7 @@ public class FieldView extends PlainView {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the bounding box of the given position
|
||||
* @exception BadLocationException if the given position does not
|
||||
@ -269,8 +269,8 @@ public class FieldView extends PlainView {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param fx the X coordinate >= 0.0f
|
||||
* @param fy the Y coordinate >= 0.0f
|
||||
* @param fx the X coordinate >= 0.0f
|
||||
* @param fy the Y coordinate >= 0.0f
|
||||
* @param a the allocated region to render into
|
||||
* @return the location within the model that best represents the
|
||||
* given point in the view
|
||||
|
||||
@ -88,7 +88,7 @@ public abstract class FlowView extends BoxView {
|
||||
* is returned.
|
||||
*
|
||||
* @param index the index of the row being updated.
|
||||
* This should be a value >= 0 and < getViewCount().
|
||||
* This should be a value >= 0 and < getViewCount().
|
||||
* @see #getFlowStart
|
||||
*/
|
||||
public int getFlowSpan(int index) {
|
||||
@ -103,7 +103,7 @@ public abstract class FlowView extends BoxView {
|
||||
* for the row constraints.
|
||||
|
||||
* @param index the index of the row being updated.
|
||||
* This should be a value >= 0 and < getViewCount().
|
||||
* This should be a value >= 0 and < getViewCount().
|
||||
* @see #getFlowSpan
|
||||
*/
|
||||
public int getFlowStart(int index) {
|
||||
@ -147,7 +147,7 @@ public abstract class FlowView extends BoxView {
|
||||
* Fetches the child view index representing the given position in
|
||||
* the model.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @return index of the view representing the given position, or
|
||||
* -1 if no view represents that position
|
||||
*/
|
||||
@ -175,9 +175,9 @@ public abstract class FlowView extends BoxView {
|
||||
* a preferenceChanged is called. Following all of that,
|
||||
* the normal box layout of the superclass is performed.
|
||||
*
|
||||
* @param width the width to lay out against >= 0. This is
|
||||
* @param width the width to lay out against >= 0. This is
|
||||
* the width inside of the inset area.
|
||||
* @param height the height to lay out against >= 0 This
|
||||
* @param height the height to lay out against >= 0 This
|
||||
* is the height inside of the inset area.
|
||||
*/
|
||||
protected void layout(int width, int height) {
|
||||
@ -580,7 +580,7 @@ public abstract class FlowView extends BoxView {
|
||||
*
|
||||
* @param rowIndex the row to adjust to the current layout
|
||||
* span.
|
||||
* @param desiredSpan the current layout span >= 0
|
||||
* @param desiredSpan the current layout span >= 0
|
||||
* @param x the location r starts at.
|
||||
*/
|
||||
protected void adjustRow(FlowView fv, int rowIndex, int desiredSpan, int x) {
|
||||
@ -832,8 +832,8 @@ public abstract class FlowView extends BoxView {
|
||||
* Implemented to return false, as hit detection is not
|
||||
* performed on the logical view.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the rectangle
|
||||
* @return true if the point is before the specified range
|
||||
*/
|
||||
@ -846,8 +846,8 @@ public abstract class FlowView extends BoxView {
|
||||
* Implemented to return false, as hit detection is not
|
||||
* performed on the logical view.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the rectangle
|
||||
* @return true if the point is after the specified range
|
||||
*/
|
||||
@ -860,8 +860,8 @@ public abstract class FlowView extends BoxView {
|
||||
* Implemented to return null, as hit detection is not
|
||||
* performed on the logical view.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param alloc the parent's allocation on entry, which should
|
||||
* be changed to the child's allocation on exit
|
||||
* @return the child view
|
||||
@ -875,7 +875,7 @@ public abstract class FlowView extends BoxView {
|
||||
* Implemented to do nothing, as the logical view doesn't
|
||||
* perform layout on the children.
|
||||
*
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param index the index of the child, >= 0 && < getViewCount()
|
||||
* @param a the allocation to the interior of the box on entry,
|
||||
* and the allocation of the child view at the index on exit.
|
||||
*/
|
||||
|
||||
@ -107,7 +107,7 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
/**
|
||||
* Returns the length of the content.
|
||||
*
|
||||
* @return the length >= 1
|
||||
* @return the length >= 1
|
||||
* @see AbstractDocument.Content#length
|
||||
*/
|
||||
public int length() {
|
||||
@ -118,7 +118,7 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
/**
|
||||
* Inserts a string into the content.
|
||||
*
|
||||
* @param where the starting position >= 0, < length()
|
||||
* @param where the starting position >= 0, < length()
|
||||
* @param str the non-null string to insert
|
||||
* @return an UndoableEdit object for undoing
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
@ -136,8 +136,8 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
/**
|
||||
* Removes part of the content.
|
||||
*
|
||||
* @param where the starting position >= 0, where + nitems < length()
|
||||
* @param nitems the number of characters to remove >= 0
|
||||
* @param where the starting position >= 0, where + nitems < length()
|
||||
* @param nitems the number of characters to remove >= 0
|
||||
* @return an UndoableEdit object for undoing
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
* @see AbstractDocument.Content#remove
|
||||
@ -156,8 +156,8 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
/**
|
||||
* Retrieves a portion of the content.
|
||||
*
|
||||
* @param where the starting position >= 0
|
||||
* @param len the length to retrieve >= 0
|
||||
* @param where the starting position >= 0
|
||||
* @param len the length to retrieve >= 0
|
||||
* @return a string representing the content
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
* @see AbstractDocument.Content#getString
|
||||
@ -174,8 +174,8 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
* span the gap, the actual store is returned to avoid the copy since
|
||||
* it is contiguous.
|
||||
*
|
||||
* @param where the starting position >= 0, where + len <= length()
|
||||
* @param len the number of characters to retrieve >= 0
|
||||
* @param where the starting position >= 0, where + len <= length()
|
||||
* @param len the number of characters to retrieve >= 0
|
||||
* @param chars the Segment object to return the characters in
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
* @see AbstractDocument.Content#getChars
|
||||
@ -222,7 +222,7 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
* Creates a position within the content that will
|
||||
* track change as the content is mutated.
|
||||
*
|
||||
* @param offset the offset to track >= 0
|
||||
* @param offset the offset to track >= 0
|
||||
* @return the position
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
*/
|
||||
@ -705,8 +705,8 @@ public class GapContent extends GapVector implements AbstractDocument.Content, S
|
||||
* there. The vector with the resulting Positions are returned.
|
||||
*
|
||||
* @param v the Vector to use, with a new one created on null
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @return the set of instances
|
||||
*/
|
||||
protected Vector getPositionsInRange(Vector v, int offset, int length) {
|
||||
|
||||
@ -121,8 +121,8 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* the GlyphPainter to determine what characters
|
||||
* it should render glyphs for.
|
||||
*
|
||||
* @param p0 the starting document offset >= 0
|
||||
* @param p1 the ending document offset >= p0
|
||||
* @param p0 the starting document offset >= 0
|
||||
* @param p1 the ending document offset >= p0
|
||||
* @return the <code>Segment</code> containing the text
|
||||
*/
|
||||
public Segment getText(int p0, int p1) {
|
||||
@ -282,9 +282,9 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* tab expansion implementation.
|
||||
*
|
||||
* @param x the position the view would be located
|
||||
* at for the purpose of tab expansion >= 0.
|
||||
* at for the purpose of tab expansion >= 0.
|
||||
* @param e how to expand the tabs when encountered.
|
||||
* @return the desired span >= 0
|
||||
* @return the desired span >= 0
|
||||
* @see TabableView#getTabbedSpan
|
||||
*/
|
||||
public float getTabbedSpan(float x, TabExpander e) {
|
||||
@ -321,9 +321,9 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* arrange for its own text buffer to make the
|
||||
* measurements.
|
||||
*
|
||||
* @param p0 the starting document offset >= 0
|
||||
* @param p1 the ending document offset >= p0
|
||||
* @return the span >= 0
|
||||
* @param p0 the starting document offset >= 0
|
||||
* @param p1 the ending document offset >= p0
|
||||
* @return the span >= 0
|
||||
*/
|
||||
public float getPartialSpan(int p0, int p1) {
|
||||
checkPainter();
|
||||
@ -572,7 +572,7 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* axis.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
@ -639,7 +639,7 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param b either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code>
|
||||
@ -657,14 +657,14 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param biasReturn either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code> is returned as the
|
||||
* zero-th element of this array
|
||||
* @return the location within the model that best represents the
|
||||
* given point of view >= 0
|
||||
* given point of view >= 0
|
||||
* @see View#viewToModel
|
||||
*/
|
||||
public int viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn) {
|
||||
@ -702,10 +702,10 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @param pos the potential location of the start of the
|
||||
* broken view >= 0. This may be useful for calculating tab
|
||||
* broken view >= 0. This may be useful for calculating tab
|
||||
* positions.
|
||||
* @param len specifies the relative length from <em>pos</em>
|
||||
* where a potential break is desired >= 0.
|
||||
* where a potential break is desired >= 0.
|
||||
* @return the weight, which should be a value between
|
||||
* View.ForcedBreakWeight and View.BadBreakWeight.
|
||||
* @see LabelView
|
||||
@ -736,12 +736,12 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @param p0 the location in the model where the
|
||||
* fragment should start it's representation >= 0.
|
||||
* fragment should start it's representation >= 0.
|
||||
* @param pos the position along the axis that the
|
||||
* broken view would occupy >= 0. This may be useful for
|
||||
* broken view would occupy >= 0. This may be useful for
|
||||
* things like tab calculations.
|
||||
* @param len specifies the distance along the axis
|
||||
* where a potential break is desired >= 0.
|
||||
* where a potential break is desired >= 0.
|
||||
* @return the fragment of the view that represents the
|
||||
* given span, if the view can be broken. If the view
|
||||
* doesn't support breaking behavior, the view itself is
|
||||
@ -852,10 +852,10 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* to return a nested class that shares state in this view
|
||||
* representing only a portion of the view.
|
||||
*
|
||||
* @param p0 the starting offset >= 0. This should be a value
|
||||
* @param p0 the starting offset >= 0. This should be a value
|
||||
* greater or equal to the element starting offset and
|
||||
* less than the element ending offset.
|
||||
* @param p1 the ending offset > p0. This should be a value
|
||||
* @param p1 the ending offset > p0. This should be a value
|
||||
* less than or equal to the elements end offset and
|
||||
* greater than the elements starting offset.
|
||||
* @return the view fragment, or itself if the view doesn't
|
||||
@ -880,7 +880,7 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* they just might not allow access to some of the locations in the
|
||||
* model.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param direction the direction from the current position that can
|
||||
* be thought of as the arrow keys typically found on a keyboard.
|
||||
@ -1196,12 +1196,12 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
*
|
||||
* @param v the view to find the model location to break at.
|
||||
* @param p0 the location in the model where the
|
||||
* fragment should start it's representation >= 0.
|
||||
* fragment should start it's representation >= 0.
|
||||
* @param x the graphic location along the axis that the
|
||||
* broken view would occupy >= 0. This may be useful for
|
||||
* broken view would occupy >= 0. This may be useful for
|
||||
* things like tab calculations.
|
||||
* @param len specifies the distance into the view
|
||||
* where a potential break is desired >= 0.
|
||||
* where a potential break is desired >= 0.
|
||||
* @return the maximum model location possible for a break.
|
||||
* @see View#breakView
|
||||
*/
|
||||
@ -1214,8 +1214,8 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* the painter doesn't hold any significant state, it can
|
||||
* return itself. The default behavior is to return itself.
|
||||
* @param v the <code>GlyphView</code> to provide a painter for
|
||||
* @param p0 the starting document offset >= 0
|
||||
* @param p1 the ending document offset >= p0
|
||||
* @param p0 the starting document offset >= 0
|
||||
* @param p1 the ending document offset >= p0
|
||||
*/
|
||||
public GlyphPainter getPainter(GlyphView v, int p0, int p1) {
|
||||
return this;
|
||||
@ -1229,7 +1229,7 @@ public class GlyphView extends View implements TabableView, Cloneable {
|
||||
* model.
|
||||
*
|
||||
* @param v the view to use
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param b either <code>Position.Bias.Forward</code>
|
||||
* or <code>Position.Bias.Backward</code>
|
||||
* @param a the allocated region to render into
|
||||
|
||||
@ -66,8 +66,8 @@ public interface Highlighter {
|
||||
* Adds a highlight to the view. Returns a tag that can be used
|
||||
* to refer to the highlight.
|
||||
*
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p the painter to use for the actual highlighting
|
||||
* @return an object that refers to the highlight
|
||||
* @exception BadLocationException for an invalid range specification
|
||||
@ -93,8 +93,8 @@ public interface Highlighter {
|
||||
* with a mouse) by damaging only what changed.
|
||||
*
|
||||
* @param tag which highlight to change
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @param p0 the beginning of the range >= 0
|
||||
* @param p1 the end of the range >= p0
|
||||
* @exception BadLocationException for an invalid range specification
|
||||
*/
|
||||
public void changeHighlight(Object tag, int p0, int p1) throws BadLocationException;
|
||||
@ -115,8 +115,8 @@ public interface Highlighter {
|
||||
* Renders the highlight.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param p0 the starting offset in the model >= 0
|
||||
* @param p1 the ending offset in the model >= p0
|
||||
* @param p0 the starting offset in the model >= 0
|
||||
* @param p1 the ending offset in the model >= p0
|
||||
* @param bounds the bounding box for the highlight
|
||||
* @param c the editor
|
||||
*/
|
||||
@ -129,14 +129,14 @@ public interface Highlighter {
|
||||
/**
|
||||
* Gets the starting model offset for the highlight.
|
||||
*
|
||||
* @return the starting offset >= 0
|
||||
* @return the starting offset >= 0
|
||||
*/
|
||||
public int getStartOffset();
|
||||
|
||||
/**
|
||||
* Gets the ending model offset for the highlight.
|
||||
*
|
||||
* @return the ending offset >= 0
|
||||
* @return the ending offset >= 0
|
||||
*/
|
||||
public int getEndOffset();
|
||||
|
||||
|
||||
@ -101,7 +101,7 @@ public class IconView extends View {
|
||||
* along the x axis.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the desired alignment >= 0.0f && <= 1.0f. This should be
|
||||
* @return the desired alignment >= 0.0f && <= 1.0f. This should be
|
||||
* a value between 0.0 and 1.0 where 0 indicates alignment at the
|
||||
* origin and 1.0 indicates alignment to the full span
|
||||
* away from the origin. An alignment of 0.5 would be the
|
||||
@ -120,7 +120,7 @@ public class IconView extends View {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the bounding box of the given position
|
||||
* @exception BadLocationException if the given position does not
|
||||
@ -145,11 +145,11 @@ public class IconView extends View {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @param y the Y coordinate >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the location within the model that best represents the
|
||||
* given point of view >= 0
|
||||
* given point of view >= 0
|
||||
* @see View#viewToModel
|
||||
*/
|
||||
public int viewToModel(float x, float y, Shape a, Position.Bias[] bias) {
|
||||
|
||||
@ -57,7 +57,7 @@ public class NavigationFilter {
|
||||
* on the <code>FilterBypass</code>
|
||||
*
|
||||
* @param fb FilterBypass that can be used to mutate caret position
|
||||
* @param dot the position >= 0
|
||||
* @param dot the position >= 0
|
||||
* @param bias Bias to place the dot at
|
||||
*/
|
||||
public void setDot(FilterBypass fb, int dot, Position.Bias bias) {
|
||||
@ -72,7 +72,7 @@ public class NavigationFilter {
|
||||
* methods on the <code>FilterBypass</code>.
|
||||
*
|
||||
* @param fb FilterBypass that can be used to mutate caret position
|
||||
* @param dot the position >= 0
|
||||
* @param dot the position >= 0
|
||||
* @param bias Bias for new location
|
||||
*/
|
||||
public void moveDot(FilterBypass fb, int dot, Position.Bias bias) {
|
||||
@ -131,7 +131,7 @@ public class NavigationFilter {
|
||||
/**
|
||||
* Sets the caret location, bypassing the NavigationFilter.
|
||||
*
|
||||
* @param dot the position >= 0
|
||||
* @param dot the position >= 0
|
||||
* @param bias Bias to place the dot at
|
||||
*/
|
||||
public abstract void setDot(int dot, Position.Bias bias);
|
||||
@ -139,7 +139,7 @@ public class NavigationFilter {
|
||||
/**
|
||||
* Moves the caret location, bypassing the NavigationFilter.
|
||||
*
|
||||
* @param dot the position >= 0
|
||||
* @param dot the position >= 0
|
||||
* @param bias Bias for new location
|
||||
*/
|
||||
public abstract void moveDot(int dot, Position.Bias bias);
|
||||
|
||||
@ -409,8 +409,8 @@ public class ParagraphView extends FlowView implements TabExpander {
|
||||
*
|
||||
* @param x the X reference position
|
||||
* @param tabOffset the position within the text stream
|
||||
* that the tab occurred at >= 0
|
||||
* @return the trailing end of the tab expansion >= 0
|
||||
* that the tab occurred at >= 0
|
||||
* @return the trailing end of the tab expansion >= 0
|
||||
* @see TabSet
|
||||
* @see TabStop
|
||||
* @see LabelView
|
||||
@ -489,9 +489,9 @@ public class ParagraphView extends FlowView implements TabExpander {
|
||||
* the <code>TabableView</code> interface,
|
||||
* the <code>preferredSpan</code> will be used.
|
||||
*
|
||||
* @param startOffset the starting document offset >= 0
|
||||
* @param endOffset the ending document offset >= startOffset
|
||||
* @return the size >= 0
|
||||
* @param startOffset the starting document offset >= 0
|
||||
* @param endOffset the ending document offset >= startOffset
|
||||
* @return the size >= 0
|
||||
*/
|
||||
protected float getPartialSize(int startOffset, int endOffset) {
|
||||
float size = 0.0f;
|
||||
@ -529,7 +529,7 @@ public class ParagraphView extends FlowView implements TabExpander {
|
||||
* there are no characters found, -1 will be returned.
|
||||
*
|
||||
* @param string the string of characters
|
||||
* @param start where to start in the model >= 0
|
||||
* @param start where to start in the model >= 0
|
||||
* @return the document offset, or -1 if no characters found
|
||||
*/
|
||||
protected int findOffsetToCharactersInString(char[] string,
|
||||
@ -642,7 +642,7 @@ public class ParagraphView extends FlowView implements TabExpander {
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @param len specifies where a potential break is desired
|
||||
* along the given axis >= 0
|
||||
* along the given axis >= 0
|
||||
* @param a the current allocation of the view
|
||||
* @return the fragment of the view that represents the
|
||||
* given span, if the view can be broken; if the view
|
||||
@ -675,7 +675,7 @@ public class ParagraphView extends FlowView implements TabExpander {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @param len specifies where a potential break is desired >= 0
|
||||
* @param len specifies where a potential break is desired >= 0
|
||||
* @return a value indicating the attractiveness of breaking here;
|
||||
* either <code>GoodBreakWeight</code> or <code>BadBreakWeight</code>
|
||||
* @see View#getBreakWeight
|
||||
@ -1141,7 +1141,7 @@ public class ParagraphView extends FlowView implements TabExpander {
|
||||
* Fetches the child view index representing the given position in
|
||||
* the model.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @return index of the view representing the given position, or
|
||||
* -1 if no view represents that position
|
||||
*/
|
||||
|
||||
@ -55,11 +55,11 @@ public class PasswordView extends FieldView {
|
||||
* using the value returned by getEchoChar().
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the starting offset in the model >= 0
|
||||
* @param p1 the ending offset in the model >= p0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the starting offset in the model >= 0
|
||||
* @param p1 the ending offset in the model >= p0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @exception BadLocationException if p0 or p1 are out of range
|
||||
*/
|
||||
protected int drawUnselectedText(Graphics g, int x, int y,
|
||||
@ -94,11 +94,11 @@ public class PasswordView extends FieldView {
|
||||
* display the characters.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the starting offset in the model >= 0
|
||||
* @param p1 the ending offset in the model >= p0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the starting offset in the model >= 0
|
||||
* @param p1 the ending offset in the model >= p0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @exception BadLocationException if p0 or p1 are out of range
|
||||
*/
|
||||
protected int drawSelectedText(Graphics g, int x,
|
||||
@ -126,10 +126,10 @@ public class PasswordView extends FieldView {
|
||||
* or unselected text.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param c the echo character
|
||||
* @return the updated X position >= 0
|
||||
* @return the updated X position >= 0
|
||||
*/
|
||||
protected int drawEchoCharacter(Graphics g, int x, int y, char c) {
|
||||
ONE[0] = c;
|
||||
@ -142,7 +142,7 @@ public class PasswordView extends FieldView {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the bounding box of the given position
|
||||
* @exception BadLocationException if the given position does not
|
||||
@ -172,8 +172,8 @@ public class PasswordView extends FieldView {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param fx the X coordinate >= 0.0f
|
||||
* @param fy the Y coordinate >= 0.0f
|
||||
* @param fx the X coordinate >= 0.0f
|
||||
* @param fy the Y coordinate >= 0.0f
|
||||
* @param a the allocated region to render into
|
||||
* @return the location within the model that best represents the
|
||||
* given point in the view
|
||||
@ -210,7 +210,7 @@ public class PasswordView extends FieldView {
|
||||
* axis.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
|
||||
@ -103,7 +103,7 @@ public class PlainDocument extends AbstractDocument {
|
||||
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
|
||||
* in Swing</A> for more information.
|
||||
*
|
||||
* @param offs the starting offset >= 0
|
||||
* @param offs the starting offset >= 0
|
||||
* @param str the string to insert; does nothing with null/empty strings
|
||||
* @param a the attributes for the inserted content
|
||||
* @exception BadLocationException the given insert position is not a valid
|
||||
|
||||
@ -66,10 +66,10 @@ public class PlainView extends View implements TabExpander {
|
||||
* <code>drawSelectedText</code> so that the way selected and
|
||||
* unselected text are rendered can be customized.
|
||||
*
|
||||
* @param lineIndex the line to draw >= 0
|
||||
* @param lineIndex the line to draw >= 0
|
||||
* @param g the <code>Graphics</code> context
|
||||
* @param x the starting X position >= 0
|
||||
* @param y the starting Y position >= 0
|
||||
* @param x the starting X position >= 0
|
||||
* @param y the starting Y position >= 0
|
||||
* @see #drawUnselectedText
|
||||
* @see #drawSelectedText
|
||||
*/
|
||||
@ -138,11 +138,11 @@ public class PlainView extends View implements TabExpander {
|
||||
* text. Uses the foreground or disabled color to render the text.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= 0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= 0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @exception BadLocationException if the range is invalid
|
||||
*/
|
||||
protected int drawUnselectedText(Graphics g, int x, int y,
|
||||
@ -163,10 +163,10 @@ public class PlainView extends View implements TabExpander {
|
||||
* the selected background.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= 0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= 0
|
||||
* @return the location of the end of the range
|
||||
* @exception BadLocationException if the range is invalid
|
||||
*/
|
||||
@ -218,7 +218,7 @@ public class PlainView extends View implements TabExpander {
|
||||
* axis.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
@ -332,7 +332,7 @@ public class PlainView extends View implements TabExpander {
|
||||
* Provides a mapping from the document model coordinate space
|
||||
* to the coordinate space of the view mapped to it.
|
||||
*
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the bounding box of the given position
|
||||
* @exception BadLocationException if the given position does not
|
||||
@ -369,11 +369,11 @@ public class PlainView extends View implements TabExpander {
|
||||
* Provides a mapping from the view coordinate space to the logical
|
||||
* coordinate space of the model.
|
||||
*
|
||||
* @param fx the X coordinate >= 0
|
||||
* @param fy the Y coordinate >= 0
|
||||
* @param fx the X coordinate >= 0
|
||||
* @param fy the Y coordinate >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @return the location within the model that best represents the
|
||||
* given point in the view >= 0
|
||||
* given point in the view >= 0
|
||||
* @see View#viewToModel
|
||||
*/
|
||||
public int viewToModel(float fx, float fy, Shape a, Position.Bias[] bias) {
|
||||
@ -482,8 +482,8 @@ public class PlainView extends View implements TabExpander {
|
||||
* layout of the view along the given axis, if it
|
||||
* has any layout duties.
|
||||
*
|
||||
* @param width the width >= 0
|
||||
* @param height the height >= 0
|
||||
* @param width the width >= 0
|
||||
* @param height the height >= 0
|
||||
*/
|
||||
public void setSize(float width, float height) {
|
||||
super.setSize(width, height);
|
||||
@ -497,10 +497,10 @@ public class PlainView extends View implements TabExpander {
|
||||
* This implementation does not support things like centering so it
|
||||
* ignores the tabOffset argument.
|
||||
*
|
||||
* @param x the current position >= 0
|
||||
* @param x the current position >= 0
|
||||
* @param tabOffset the position within the text stream
|
||||
* that the tab occurred at >= 0.
|
||||
* @return the tab stop, measured in points >= 0
|
||||
* that the tab occurred at >= 0.
|
||||
* @return the tab stop, measured in points >= 0
|
||||
*/
|
||||
public float nextTabStop(float x, int tabOffset) {
|
||||
if (tabSize == 0) {
|
||||
|
||||
@ -51,7 +51,7 @@ public interface Position {
|
||||
/**
|
||||
* Fetches the current offset within the document.
|
||||
*
|
||||
* @return the offset >= 0
|
||||
* @return the offset >= 0
|
||||
*/
|
||||
public int getOffset();
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
|
||||
/**
|
||||
* Creates a new StringContent object, with the initial
|
||||
* size specified. If the length is < 1, a size of 1 is used.
|
||||
* size specified. If the length is < 1, a size of 1 is used.
|
||||
*
|
||||
* @param initialLength the initial size
|
||||
*/
|
||||
@ -77,7 +77,7 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
/**
|
||||
* Returns the length of the content.
|
||||
*
|
||||
* @return the length >= 1
|
||||
* @return the length >= 1
|
||||
* @see AbstractDocument.Content#length
|
||||
*/
|
||||
public int length() {
|
||||
@ -87,7 +87,7 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
/**
|
||||
* Inserts a string into the content.
|
||||
*
|
||||
* @param where the starting position >= 0 && < length()
|
||||
* @param where the starting position >= 0 && < length()
|
||||
* @param str the non-null string to insert
|
||||
* @return an UndoableEdit object for undoing
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
@ -106,10 +106,10 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes part of the content. where + nitems must be < length().
|
||||
* Removes part of the content. where + nitems must be < length().
|
||||
*
|
||||
* @param where the starting position >= 0
|
||||
* @param nitems the number of characters to remove >= 0
|
||||
* @param where the starting position >= 0
|
||||
* @param nitems the number of characters to remove >= 0
|
||||
* @return an UndoableEdit object for undoing
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
* @see AbstractDocument.Content#remove
|
||||
@ -129,10 +129,10 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a portion of the content. where + len must be <= length().
|
||||
* Retrieves a portion of the content. where + len must be <= length().
|
||||
*
|
||||
* @param where the starting position >= 0
|
||||
* @param len the length to retrieve >= 0
|
||||
* @param where the starting position >= 0
|
||||
* @param len the length to retrieve >= 0
|
||||
* @return a string representing the content; may be empty
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
* @see AbstractDocument.Content#getString
|
||||
@ -145,10 +145,10 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a portion of the content. where + len must be <= length()
|
||||
* Retrieves a portion of the content. where + len must be <= length()
|
||||
*
|
||||
* @param where the starting position >= 0
|
||||
* @param len the number of characters to retrieve >= 0
|
||||
* @param where the starting position >= 0
|
||||
* @param len the number of characters to retrieve >= 0
|
||||
* @param chars the Segment object to return the characters in
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
* @see AbstractDocument.Content#getChars
|
||||
@ -166,7 +166,7 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
* Creates a position within the content that will
|
||||
* track change as the content is mutated.
|
||||
*
|
||||
* @param offset the offset to create a position for >= 0
|
||||
* @param offset the offset to create a position for >= 0
|
||||
* @return the position
|
||||
* @exception BadLocationException if the specified position is invalid
|
||||
*/
|
||||
@ -266,8 +266,8 @@ public final class StringContent implements AbstractDocument.Content, Serializab
|
||||
* to subclasses.
|
||||
*
|
||||
* @param v the Vector to use, with a new one created on null
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @param offset the starting offset >= 0
|
||||
* @param length the length >= 0
|
||||
* @return the set of instances
|
||||
*/
|
||||
protected Vector getPositionsInRange(Vector v, int offset,
|
||||
|
||||
@ -241,7 +241,7 @@ public class StyleContext implements Serializable, AbstractDocument.AttributeCon
|
||||
*
|
||||
* @param family the font family (such as "Monospaced")
|
||||
* @param style the style of the font (such as Font.PLAIN)
|
||||
* @param size the point size >= 1
|
||||
* @param size the point size >= 1
|
||||
* @return the new font
|
||||
*/
|
||||
public Font getFont(String family, int style, int size) {
|
||||
@ -1387,7 +1387,7 @@ public class StyleContext implements Serializable, AbstractDocument.AttributeCon
|
||||
/**
|
||||
* Gets the number of attributes that are defined.
|
||||
*
|
||||
* @return the number of attributes >= 0
|
||||
* @return the number of attributes >= 0
|
||||
* @see AttributeSet#getAttributeCount
|
||||
*/
|
||||
public int getAttributeCount() {
|
||||
|
||||
@ -76,8 +76,8 @@ public interface StyledDocument extends Document {
|
||||
* giving an Attributes argument that has no attributes defined
|
||||
* and setting replace to true.
|
||||
*
|
||||
* @param offset the start of the change >= 0
|
||||
* @param length the length of the change >= 0
|
||||
* @param offset the start of the change >= 0
|
||||
* @param length the length of the change >= 0
|
||||
* @param s the non-null attributes to change to. Any attributes
|
||||
* defined will be applied to the text for the given range.
|
||||
* @param replace indicates whether or not the previous
|
||||
@ -91,8 +91,8 @@ public interface StyledDocument extends Document {
|
||||
/**
|
||||
* Sets paragraph attributes.
|
||||
*
|
||||
* @param offset the start of the change >= 0
|
||||
* @param length the length of the change >= 0
|
||||
* @param offset the start of the change >= 0
|
||||
* @param length the length of the change >= 0
|
||||
* @param s the non-null attributes to change to. Any attributes
|
||||
* defined will be applied to the text for the given range.
|
||||
* @param replace indicates whether or not the previous
|
||||
@ -111,7 +111,7 @@ public interface StyledDocument extends Document {
|
||||
* in turn may resolve through some hierarchy completely
|
||||
* independent of the element hierarchy in the document.
|
||||
*
|
||||
* @param pos the starting position >= 0
|
||||
* @param pos the starting position >= 0
|
||||
* @param s the style to set
|
||||
*/
|
||||
public void setLogicalStyle(int pos, Style s);
|
||||
@ -119,7 +119,7 @@ public interface StyledDocument extends Document {
|
||||
/**
|
||||
* Gets a logical style for a given position in a paragraph.
|
||||
*
|
||||
* @param p the position >= 0
|
||||
* @param p the position >= 0
|
||||
* @return the style
|
||||
*/
|
||||
public Style getLogicalStyle(int p);
|
||||
@ -128,7 +128,7 @@ public interface StyledDocument extends Document {
|
||||
* Gets the element that represents the paragraph that
|
||||
* encloses the given offset within the document.
|
||||
*
|
||||
* @param pos the offset >= 0
|
||||
* @param pos the offset >= 0
|
||||
* @return the element
|
||||
*/
|
||||
public Element getParagraphElement(int pos);
|
||||
@ -137,7 +137,7 @@ public interface StyledDocument extends Document {
|
||||
* Gets the element that represents the character that
|
||||
* is at the given offset within the document.
|
||||
*
|
||||
* @param pos the offset >= 0
|
||||
* @param pos the offset >= 0
|
||||
* @return the element
|
||||
*/
|
||||
public Element getCharacterElement(int pos);
|
||||
|
||||
@ -689,7 +689,7 @@ public class StyledEditorKit extends DefaultEditorKit {
|
||||
* Creates a new AlignmentAction.
|
||||
*
|
||||
* @param nm the action name
|
||||
* @param a the alignment >= 0
|
||||
* @param a the alignment >= 0
|
||||
*/
|
||||
public AlignmentAction(String nm, int a) {
|
||||
super(nm);
|
||||
|
||||
@ -37,10 +37,10 @@ public interface TabExpander {
|
||||
* Returns the next tab stop position given a reference
|
||||
* position. Values are expressed in points.
|
||||
*
|
||||
* @param x the position in points >= 0
|
||||
* @param x the position in points >= 0
|
||||
* @param tabOffset the position within the text stream
|
||||
* that the tab occurred at >= 0.
|
||||
* @return the next tab stop >= 0
|
||||
* that the tab occurred at >= 0.
|
||||
* @return the next tab stop >= 0
|
||||
*/
|
||||
float nextTabStop(float x, int tabOffset);
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ public interface TabableView {
|
||||
* along the axis of tab expansion.
|
||||
*
|
||||
* @param x the position the view would be located
|
||||
* at for the purpose of tab expansion >= 0.
|
||||
* at for the purpose of tab expansion >= 0.
|
||||
* @param e how to expand the tabs when encountered.
|
||||
* @return the desired span >= 0
|
||||
* @return the desired span >= 0
|
||||
*/
|
||||
float getTabbedSpan(float x, TabExpander e);
|
||||
|
||||
@ -62,9 +62,9 @@ public interface TabableView {
|
||||
* an assumption that the range given does not
|
||||
* contain tabs.
|
||||
*
|
||||
* @param p0 the starting location in the text document >= 0
|
||||
* @param p1 the ending location in the text document >= p0
|
||||
* @return the span >= 0
|
||||
* @param p0 the starting location in the text document >= 0
|
||||
* @param p1 the ending location in the text document >= p0
|
||||
* @return the span >= 0
|
||||
*/
|
||||
float getPartialSpan(int p0, int p1);
|
||||
}
|
||||
|
||||
@ -542,7 +542,7 @@ public abstract class TableView extends BoxView {
|
||||
* view the children do not necessarily have a one to one mapping
|
||||
* with the child elements.
|
||||
*
|
||||
* @param pos the search position >= 0
|
||||
* @param pos the search position >= 0
|
||||
* @param a the allocation to the table on entry, and the
|
||||
* allocation of the view containing the position on exit
|
||||
* @return the view representing the given position, or
|
||||
@ -755,7 +755,7 @@ public abstract class TableView extends BoxView {
|
||||
* view the children do not necessarily have a one to one mapping
|
||||
* with the child elements.
|
||||
*
|
||||
* @param pos the search position >= 0
|
||||
* @param pos the search position >= 0
|
||||
* @param a the allocation to the table on entry, and the
|
||||
* allocation of the view containing the position on exit
|
||||
* @return the view representing the given position, or
|
||||
@ -833,8 +833,8 @@ public abstract class TableView extends BoxView {
|
||||
/**
|
||||
* Sets the grid location.
|
||||
*
|
||||
* @param row the row >= 0
|
||||
* @param col the column >= 0
|
||||
* @param row the row >= 0
|
||||
* @param col the column >= 0
|
||||
*/
|
||||
public void setGridLocation(int row, int col) {
|
||||
this.row = row;
|
||||
@ -871,8 +871,8 @@ public abstract class TableView extends BoxView {
|
||||
/**
|
||||
* Sets the grid location.
|
||||
*
|
||||
* @param row the row >= 0
|
||||
* @param col the column >= 0
|
||||
* @param row the row >= 0
|
||||
* @param col the column >= 0
|
||||
*/
|
||||
public void setGridLocation(int row, int col);
|
||||
|
||||
|
||||
@ -71,12 +71,12 @@ public class Utilities {
|
||||
* where ints are used and 72dpi is assumed.
|
||||
*
|
||||
* @param s the source of the text
|
||||
* @param x the X origin >= 0
|
||||
* @param y the Y origin >= 0
|
||||
* @param x the X origin >= 0
|
||||
* @param y the Y origin >= 0
|
||||
* @param g the graphics context
|
||||
* @param e how to expand the tabs. If this value is null,
|
||||
* tabs will be expanded as a space character.
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @return the X location at the end of the rendered text
|
||||
*/
|
||||
public static final int drawTabbedText(Segment s, int x, int y, Graphics g,
|
||||
@ -92,12 +92,12 @@ public class Utilities {
|
||||
*
|
||||
* @param view View requesting rendering, may be null.
|
||||
* @param s the source of the text
|
||||
* @param x the X origin >= 0
|
||||
* @param y the Y origin >= 0
|
||||
* @param x the X origin >= 0
|
||||
* @param y the Y origin >= 0
|
||||
* @param g the graphics context
|
||||
* @param e how to expand the tabs. If this value is null,
|
||||
* tabs will be expanded as a space character.
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @return the X location at the end of the rendered text
|
||||
*/
|
||||
static final int drawTabbedText(View view,
|
||||
@ -197,10 +197,10 @@ public class Utilities {
|
||||
*
|
||||
* @param s the source of the text
|
||||
* @param metrics the font metrics to use for the calculation
|
||||
* @param x the X origin >= 0
|
||||
* @param x the X origin >= 0
|
||||
* @param e how to expand the tabs. If this value is null,
|
||||
* tabs will be expanded as a space character.
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @return the width of the text
|
||||
*/
|
||||
public static final int getTabbedTextWidth(Segment s, FontMetrics metrics, int x,
|
||||
@ -289,13 +289,13 @@ public class Utilities {
|
||||
* @param s the source of the text
|
||||
* @param metrics the font metrics to use for the calculation
|
||||
* @param x0 the starting view location representing the start
|
||||
* of the given text >= 0.
|
||||
* of the given text >= 0.
|
||||
* @param x the target view location to translate to an
|
||||
* offset into the text >= 0.
|
||||
* offset into the text >= 0.
|
||||
* @param e how to expand the tabs. If this value is null,
|
||||
* tabs will be expanded as a space character.
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @return the offset into the text >= 0
|
||||
* @param startOffset starting offset of the text in the document >= 0
|
||||
* @return the offset into the text >= 0
|
||||
*/
|
||||
public static final int getTabbedTextOffset(Segment s, FontMetrics metrics,
|
||||
int x0, int x, TabExpander e,
|
||||
@ -488,8 +488,8 @@ public class Utilities {
|
||||
* a value of -1 will be returned.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* a value of -1 will be returned.
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
@ -518,8 +518,8 @@ public class Utilities {
|
||||
* a value of -1 will be returned.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* a value of -1 will be returned.
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
@ -549,9 +549,9 @@ public class Utilities {
|
||||
* a value of -1 will be returned.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* @param offs the offset in the document >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* a value of -1 will be returned.
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
@ -586,9 +586,9 @@ public class Utilities {
|
||||
* a value of -1 will be returned.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* @param offs the offset in the document >= 0
|
||||
* @param x the X coordinate >= 0
|
||||
* @return the position >= 0 if the request can be computed, otherwise
|
||||
* a value of -1 will be returned.
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
@ -622,8 +622,8 @@ public class Utilities {
|
||||
* Uses BreakIterator.getWordInstance() to actually get the words.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word start >= 0
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word start >= 0
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
public static final int getWordStart(JTextComponent c, int offs) throws BadLocationException {
|
||||
@ -656,8 +656,8 @@ public class Utilities {
|
||||
* Uses BreakIterator.getWordInstance() to actually get the words.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word end >= 0
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word end >= 0
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
public static final int getWordEnd(JTextComponent c, int offs) throws BadLocationException {
|
||||
@ -689,8 +689,8 @@ public class Utilities {
|
||||
* Uses BreakIterator.getWordInstance() to actually get the words.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word start >= 0
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word start >= 0
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
public static final int getNextWord(JTextComponent c, int offs) throws BadLocationException {
|
||||
@ -767,8 +767,8 @@ public class Utilities {
|
||||
* Uses BreakIterator.getWordInstance() to actually get the words.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word start >= 0
|
||||
* @param offs the offset in the document >= 0
|
||||
* @return the location in the model of the word start >= 0
|
||||
* @exception BadLocationException if the offset is out of range
|
||||
*/
|
||||
public static final int getPreviousWord(JTextComponent c, int offs) throws BadLocationException {
|
||||
@ -841,7 +841,7 @@ public class Utilities {
|
||||
* Determines the element to use for a paragraph/line.
|
||||
*
|
||||
* @param c the editor
|
||||
* @param offs the starting offset in the document >= 0
|
||||
* @param offs the starting offset in the document >= 0
|
||||
* @return the element
|
||||
*/
|
||||
public static final Element getParagraphElement(JTextComponent c, int offs) {
|
||||
@ -972,7 +972,7 @@ public class Utilities {
|
||||
* must then override the <code>flipEastAndWestAtEnds</code> method.
|
||||
*
|
||||
* @param v View to query
|
||||
* @param pos the position to convert >= 0
|
||||
* @param pos the position to convert >= 0
|
||||
* @param a the allocated region to render into
|
||||
* @param direction the direction from the current position that can
|
||||
* be thought of as the arrow keys typically found on a keyboard;
|
||||
|
||||
@ -72,12 +72,12 @@ A view has the following responsibilities:
|
||||
alt="The above text describes this graphic.">
|
||||
<p>The minimum set of methods for layout are:
|
||||
<ul>
|
||||
<li><a href="#getMinimumSpan(int)">getMinimumSpan</a>
|
||||
<li><a href="#getPreferredSpan(int)">getPreferredSpan</a>
|
||||
<li><a href="#getMaximumSpan(int)">getMaximumSpan</a>
|
||||
<li><a href="#getAlignment(int)">getAlignment</a>
|
||||
<li><a href="#preferenceChanged(javax.swing.text.View, boolean, boolean)">preferenceChanged</a>
|
||||
<li><a href="#setSize(float, float)">setSize</a>
|
||||
<li>{@link #getMinimumSpan(int) getMinimumSpan}
|
||||
<li>{@link #getPreferredSpan(int) getPreferredSpan}
|
||||
<li>{@link #getMaximumSpan(int) getMaximumSpan}
|
||||
<li>{@link #getAlignment(int) getAlignment}
|
||||
<li>{@link #preferenceChanged(javax.swing.text.View, boolean, boolean) preferenceChanged}
|
||||
<li>{@link #setSize(float, float) setSize}
|
||||
</ul>
|
||||
|
||||
<p>The <code>setSize</code> method should be prepared to be called a number of times
|
||||
@ -142,7 +142,7 @@ A view has the following responsibilities:
|
||||
</ul>
|
||||
<p>The methods for rendering are:
|
||||
<ul>
|
||||
<li><a href="#paint(java.awt.Graphics, java.awt.Shape)">paint</a>
|
||||
<li>{@link #paint(java.awt.Graphics, java.awt.Shape) paint}
|
||||
</ul>
|
||||
<p>
|
||||
|
||||
@ -153,12 +153,12 @@ A view has the following responsibilities:
|
||||
to perform translation to properly locate spatial representation of the model.
|
||||
The methods for doing this are:
|
||||
<ul>
|
||||
<li><a href="#modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape)">modelToView</a>
|
||||
<li><a href="#viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])">viewToModel</a>
|
||||
<li><a href="#getDocument()">getDocument</a>
|
||||
<li><a href="#getElement()">getElement</a>
|
||||
<li><a href="#getStartOffset()">getStartOffset</a>
|
||||
<li><a href="#getEndOffset()">getEndOffset</a>
|
||||
<li>{@link #modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape) modelToView}
|
||||
<li>{@link #viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) viewToModel}
|
||||
<li>{@link #getDocument() getDocument}
|
||||
<li>{@link #getElement() getElement}
|
||||
<li>{@link #getStartOffset() getStartOffset}
|
||||
<li>{@link #getEndOffset() getEndOffset}
|
||||
</ul>
|
||||
<p>The layout must be valid prior to attempting to make the translation.
|
||||
The translation is not valid, and must not be attempted while changes
|
||||
|
||||
@ -93,11 +93,11 @@ public class WrappedPlainView extends BoxView implements TabExpander {
|
||||
* <code>drawSelectedText</code> so that the way selected and
|
||||
* unselected text are rendered can be customized.
|
||||
*
|
||||
* @param p0 the starting document location to use >= 0
|
||||
* @param p1 the ending document location to use >= p1
|
||||
* @param p0 the starting document location to use >= 0
|
||||
* @param p1 the ending document location to use >= p1
|
||||
* @param g the graphics context
|
||||
* @param x the starting X position >= 0
|
||||
* @param y the starting Y position >= 0
|
||||
* @param x the starting X position >= 0
|
||||
* @param y the starting Y position >= 0
|
||||
* @see #drawUnselectedText
|
||||
* @see #drawSelectedText
|
||||
*/
|
||||
@ -165,11 +165,11 @@ public class WrappedPlainView extends BoxView implements TabExpander {
|
||||
* text.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= p0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= p0
|
||||
* @return the X location of the end of the range >= 0
|
||||
* @exception BadLocationException if the range is invalid
|
||||
*/
|
||||
protected int drawUnselectedText(Graphics g, int x, int y,
|
||||
@ -190,10 +190,10 @@ public class WrappedPlainView extends BoxView implements TabExpander {
|
||||
* the selected background.
|
||||
*
|
||||
* @param g the graphics context
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= p0
|
||||
* @param x the starting X coordinate >= 0
|
||||
* @param y the starting Y coordinate >= 0
|
||||
* @param p0 the beginning position in the model >= 0
|
||||
* @param p1 the ending position in the model >= p0
|
||||
* @return the location of the end of the range.
|
||||
* @exception BadLocationException if the range is invalid
|
||||
*/
|
||||
@ -326,10 +326,10 @@ public class WrappedPlainView extends BoxView implements TabExpander {
|
||||
* This implementation does not support things like centering so it
|
||||
* ignores the tabOffset argument.
|
||||
*
|
||||
* @param x the current position >= 0
|
||||
* @param x the current position >= 0
|
||||
* @param tabOffset the position within the text stream
|
||||
* that the tab occurred at >= 0.
|
||||
* @return the tab stop, measured in points >= 0
|
||||
* that the tab occurred at >= 0.
|
||||
* @return the tab stop, measured in points >= 0
|
||||
*/
|
||||
public float nextTabStop(float x, int tabOffset) {
|
||||
if (tabSize == 0)
|
||||
@ -374,8 +374,8 @@ public class WrappedPlainView extends BoxView implements TabExpander {
|
||||
* layout of the view along the given axis, if it
|
||||
* has any layout duties.
|
||||
*
|
||||
* @param width the width >= 0
|
||||
* @param height the height >= 0
|
||||
* @param width the width >= 0
|
||||
* @param height the height >= 0
|
||||
*/
|
||||
public void setSize(float width, float height) {
|
||||
updateMetrics();
|
||||
|
||||
@ -130,7 +130,7 @@ public class ZoneView extends BoxView {
|
||||
*
|
||||
* @param mzl the desired maximum number of zones
|
||||
* to be actively loaded, must be greater than 0
|
||||
* @exception IllegalArgumentException if <code>mzl</code> is < 1
|
||||
* @exception IllegalArgumentException if <code>mzl</code> is < 1
|
||||
*/
|
||||
public void setMaxZonesLoaded(int mzl) {
|
||||
if (mzl < 1) {
|
||||
@ -198,11 +198,11 @@ public class ZoneView extends BoxView {
|
||||
* implementation for a zone by changing this method.
|
||||
*
|
||||
* @param p0 the start of the desired zone. This should
|
||||
* be >= getStartOffset() and < getEndOffset(). This
|
||||
* value should also be < p1.
|
||||
* be >= getStartOffset() and < getEndOffset(). This
|
||||
* value should also be < p1.
|
||||
* @param p1 the end of the desired zone. This should
|
||||
* be > getStartOffset() and <= getEndOffset(). This
|
||||
* value should also be > p0.
|
||||
* be > getStartOffset() and <= getEndOffset(). This
|
||||
* value should also be > p0.
|
||||
*/
|
||||
protected View createZone(int p0, int p1) {
|
||||
Document doc = getDocument();
|
||||
@ -242,7 +242,7 @@ public class ZoneView extends BoxView {
|
||||
* Returns the child view index representing the given position in
|
||||
* the model.
|
||||
*
|
||||
* @param pos the position >= 0
|
||||
* @param pos the position >= 0
|
||||
* @return index of the view representing the given position, or
|
||||
* -1 if no view represents that position
|
||||
*/
|
||||
|
||||
@ -352,7 +352,7 @@ public class BlockView extends BoxView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee;
|
||||
* the parent may choose to resize or break the view
|
||||
@ -368,7 +368,7 @@ public class BlockView extends BoxView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee;
|
||||
* the parent may choose to resize or break the view
|
||||
@ -384,7 +384,7 @@ public class BlockView extends BoxView {
|
||||
*
|
||||
* @param axis may be either <code>View.X_AXIS</code>
|
||||
* or <code>View.Y_AXIS</code>
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* @return the span the view would like to be rendered into >= 0;
|
||||
* typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee;
|
||||
* the parent may choose to resize or break the view
|
||||
|
||||
@ -117,7 +117,7 @@ import javax.swing.text.*;
|
||||
* </ul>
|
||||
* <p><b>Note: for the time being we do not fully support relative units,
|
||||
* unless noted, so that
|
||||
* p { margin-top: 10% } will be treated as if no margin-top was specified.
|
||||
* p { margin-top: 10% } will be treated as if no margin-top was specified.</b>
|
||||
*
|
||||
* @author Timothy Prinzing
|
||||
* @author Scott Violet
|
||||
|
||||
@ -380,7 +380,7 @@ public class FormView extends ComponentView implements ActionListener {
|
||||
* axis of interest.
|
||||
*
|
||||
* @param axis may be either View.X_AXIS or View.Y_AXIS
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* @return the span the view would like to be rendered into >= 0.
|
||||
* Typically the view is told to render into the span
|
||||
* that is returned, although there is no guarantee.
|
||||
* The parent may choose to resize or break the view.
|
||||
|
||||
@ -107,21 +107,21 @@ import static sun.swing.SwingUtilities2.IMPLIED_CR;
|
||||
* <p>With the following HTML content:</p>
|
||||
*
|
||||
* <pre>
|
||||
* <html>
|
||||
* <head>
|
||||
* <title>An example HTMLDocument</title>
|
||||
* <style type="text/css">
|
||||
* <html>
|
||||
* <head>
|
||||
* <title>An example HTMLDocument</title>
|
||||
* <style type="text/css">
|
||||
* div { background-color: silver; }
|
||||
* ul { color: red; }
|
||||
* </style>
|
||||
* </head>
|
||||
* <body>
|
||||
* <div id="BOX">
|
||||
* <p>Paragraph 1</p>
|
||||
* <p>Paragraph 2</p>
|
||||
* </div>
|
||||
* </body>
|
||||
* </html>
|
||||
* </style>
|
||||
* </head>
|
||||
* <body>
|
||||
* <div id="BOX">
|
||||
* <p>Paragraph 1</p>
|
||||
* <p>Paragraph 2</p>
|
||||
* </div>
|
||||
* </body>
|
||||
* </html>
|
||||
* </pre>
|
||||
*
|
||||
* <p>All the methods for modifying an HTML document require an {@link
|
||||
@ -149,10 +149,10 @@ import static sun.swing.SwingUtilities2.IMPLIED_CR;
|
||||
* of any non-leaf element by using the methods
|
||||
* <code>insertAfterStart</code> and <code>insertBeforeEnd</code>.
|
||||
* For example, if <code>e</code> is the <code>DIV</code> element,
|
||||
* <code>d.insertAfterStart(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> inserts the list before the first
|
||||
* paragraph, and <code>d.insertBeforeEnd(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> inserts the list after the last
|
||||
* <code>d.insertAfterStart(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> inserts the list before the first
|
||||
* paragraph, and <code>d.insertBeforeEnd(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> inserts the list after the last
|
||||
* paragraph. The <code>DIV</code> block becomes the parent of the
|
||||
* newly inserted elements.</p>
|
||||
*
|
||||
@ -160,9 +160,9 @@ import static sun.swing.SwingUtilities2.IMPLIED_CR;
|
||||
* using the methods <code>insertBeforeStart</code> and
|
||||
* <code>insertAfterEnd</code>. For example, if <code>e</code> is the
|
||||
* <code>DIV</code> element, <code>d.insertBeforeStart(e,
|
||||
* "<ul><li>List Item</li></ul>")</code> inserts the list
|
||||
* "<ul><li>List Item</li></ul>")</code> inserts the list
|
||||
* before the <code>DIV</code> element, and <code>d.insertAfterEnd(e,
|
||||
* "<ul><li>List Item</li></ul>")</code> inserts the list
|
||||
* "<ul><li>List Item</li></ul>")</code> inserts the list
|
||||
* after the <code>DIV</code> element. The newly inserted elements
|
||||
* become siblings of the <code>DIV</code> element.</p>
|
||||
*
|
||||
@ -171,10 +171,10 @@ import static sun.swing.SwingUtilities2.IMPLIED_CR;
|
||||
* <p>Elements and all their descendants can be replaced by using the
|
||||
* methods <code>setInnerHTML</code> and <code>setOuterHTML</code>.
|
||||
* For example, if <code>e</code> is the <code>DIV</code> element,
|
||||
* <code>d.setInnerHTML(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> replaces all children paragraphs with
|
||||
* the list, and <code>d.setOuterHTML(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> replaces the <code>DIV</code> element
|
||||
* <code>d.setInnerHTML(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> replaces all children paragraphs with
|
||||
* the list, and <code>d.setOuterHTML(e, "<ul><li>List
|
||||
* Item</li></ul>")</code> replaces the <code>DIV</code> element
|
||||
* itself. In latter case the parent of the list is the
|
||||
* <code>BODY</code> element.
|
||||
*
|
||||
@ -184,6 +184,7 @@ import static sun.swing.SwingUtilities2.IMPLIED_CR;
|
||||
* of various methods described above.</p>
|
||||
*
|
||||
* <table border=1 cellspacing=0>
|
||||
* <caption></caption>
|
||||
* <tr>
|
||||
* <th>Example</th>
|
||||
* <th><code>insertAfterStart</code></th>
|
||||
@ -985,25 +986,25 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* parameter is <b>in bold</b>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / \
|
||||
* <p> <p>
|
||||
* <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Invoking <code>setInnerHTML(elem, "<ul><li>")</code>
|
||||
* <p>Invoking <code>setInnerHTML(elem, "<ul><li>")</code>
|
||||
* results in the following structure (new elements are <font
|
||||
* color="red">in red</font>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* \
|
||||
* <font color="red"><ul></font>
|
||||
* <font color="red"><ul></font>
|
||||
* \
|
||||
* <font color="red"><li></font>
|
||||
* <font color="red"><li></font>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Parameter <code>elem</code> must not be a leaf element,
|
||||
@ -1066,23 +1067,23 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* parameter is <b>in bold</b>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / \
|
||||
* <p> <p>
|
||||
* <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Invoking <code>setOuterHTML(elem, "<ul><li>")</code>
|
||||
* <p>Invoking <code>setOuterHTML(elem, "<ul><li>")</code>
|
||||
* results in the following structure (new elements are <font
|
||||
* color="red">in red</font>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <font color="red"><ul></font>
|
||||
* <font color="red"><ul></font>
|
||||
* \
|
||||
* <font color="red"><li></font>
|
||||
* <font color="red"><li></font>
|
||||
* </pre>
|
||||
*
|
||||
* <p>If either <code>elem</code> or <code>htmlText</code>
|
||||
@ -1136,25 +1137,25 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* parameter is <b>in bold</b>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / \
|
||||
* <p> <p>
|
||||
* <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Invoking <code>insertAfterStart(elem,
|
||||
* "<ul><li>")</code> results in the following structure
|
||||
* "<ul><li>")</code> results in the following structure
|
||||
* (new elements are <font color="red">in red</font>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / | \
|
||||
* <font color="red"><ul></font> <p> <p>
|
||||
* <font color="red"><ul></font> <p> <p>
|
||||
* /
|
||||
* <font color="red"><li></font>
|
||||
* <font color="red"><li></font>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Unlike the <code>insertBeforeStart</code> method, new
|
||||
@ -1206,25 +1207,25 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* parameter is <b>in bold</b>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / \
|
||||
* <p> <p>
|
||||
* <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Invoking <code>insertBeforeEnd(elem, "<ul><li>")</code>
|
||||
* <p>Invoking <code>insertBeforeEnd(elem, "<ul><li>")</code>
|
||||
* results in the following structure (new elements are <font
|
||||
* color="red">in red</font>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / | \
|
||||
* <p> <p> <font color="red"><ul></font>
|
||||
* <p> <p> <font color="red"><ul></font>
|
||||
* \
|
||||
* <font color="red"><li></font>
|
||||
* <font color="red"><li></font>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Unlike the <code>insertAfterEnd</code> method, new elements
|
||||
@ -1273,23 +1274,23 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* parameter is <b>in bold</b>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / \
|
||||
* <p> <p>
|
||||
* <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Invoking <code>insertBeforeStart(elem,
|
||||
* "<ul><li>")</code> results in the following structure
|
||||
* "<ul><li>")</code> results in the following structure
|
||||
* (new elements are <font color="red">in red</font>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* / \
|
||||
* <font color="red"><ul></font> <b><div></b>
|
||||
* <font color="red"><ul></font> <b><div></b>
|
||||
* / / \
|
||||
* <font color="red"><li></font> <p> <p>
|
||||
* <font color="red"><li></font> <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Unlike the <code>insertAfterStart</code> method, new
|
||||
@ -1331,23 +1332,23 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* parameter is <b>in bold</b>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* |
|
||||
* <b><div></b>
|
||||
* <b><div></b>
|
||||
* / \
|
||||
* <p> <p>
|
||||
* <p> <p>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Invoking <code>insertAfterEnd(elem, "<ul><li>")</code>
|
||||
* <p>Invoking <code>insertAfterEnd(elem, "<ul><li>")</code>
|
||||
* results in the following structure (new elements are <font
|
||||
* color="red">in red</font>).</p>
|
||||
*
|
||||
* <pre>
|
||||
* <body>
|
||||
* <body>
|
||||
* / \
|
||||
* <b><div></b> <font color="red"><ul></font>
|
||||
* <b><div></b> <font color="red"><ul></font>
|
||||
* / \ \
|
||||
* <p> <p> <font color="red"><li></font>
|
||||
* <p> <p> <font color="red"><li></font>
|
||||
* </pre>
|
||||
*
|
||||
* <p>Unlike the <code>insertBeforeEnd</code> method, new elements
|
||||
@ -2166,7 +2167,7 @@ public class HTMLDocument extends DefaultStyledDocument {
|
||||
* <tr><td><code>HTML.Tag.VAR</code> <td>CharacterAction
|
||||
* </table>
|
||||
* <p>
|
||||
* Once </html> is encountered, the Actions are no longer notified.
|
||||
* Once </html> is encountered, the Actions are no longer notified.
|
||||
*/
|
||||
public class HTMLReader extends HTMLEditorKit.ParserCallback {
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user