javax.swing.text
Class View

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.swing.text.View
All Implemented Interfaces:
SwingConstants sample code for javax.swing.SwingConstants definition code for javax.swing.SwingConstants
Direct Known Subclasses:
AsyncBoxView sample code for javax.swing.text.AsyncBoxView definition code for javax.swing.text.AsyncBoxView , ComponentView sample code for javax.swing.text.ComponentView definition code for javax.swing.text.ComponentView , CompositeView sample code for javax.swing.text.CompositeView definition code for javax.swing.text.CompositeView , GlyphView sample code for javax.swing.text.GlyphView definition code for javax.swing.text.GlyphView , IconView sample code for javax.swing.text.IconView definition code for javax.swing.text.IconView , ImageView sample code for javax.swing.text.html.ImageView definition code for javax.swing.text.html.ImageView , PlainView sample code for javax.swing.text.PlainView definition code for javax.swing.text.PlainView

public abstract class View
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements SwingConstants sample code for javax.swing.SwingConstants definition code for javax.swing.SwingConstants

A very important part of the text package is the View class. As the name suggests it represents a view of the text model, or a piece of the text model. It is this class that is responsible for the look of the text component. The view is not intended to be some completely new thing that one must learn, but rather is much like a lightweight component. In fact, the original View implementation was a lightweight component. There were several reasons why the Component implementation was abandoned in favor of an alternative.

  1. There was barely time to get the lightweight component support in the 1.1 version of the JDK. There simply wasn't time to lighten up the component further to where it would need to be to be used for text purposes. The additions made to JComponent increased the memory consumption, and as it currently stands its much too heavy for representing text.

  2. The layout semantics aren't quite right for text, and changing the current layout semantics of component might break existing applications.

  3. The component api uses integers, but in 1.2 one can use floating point device independent coordinates. An api that works in both 1.1 and 1.2 would be convenient for minimizing transition difficulties. The View class uses the Shape interface and float arguments to enable View implementations for the Java 2 platform v1.2 and later while still functioning in the older 1.1 JDK.

By default, a view is very light. It contains a reference to the parent view from which it can fetch many things without holding state, and it contains a reference to a portion of the model (Element). A view does not have to exactly represent an element in the model, that is simply a typical and therefore convenient mapping. A view can alternatively maintain a couple of Position objects to maintain its location in the model (i.e. represent a fragment of an element). This is typically the result of formatting where views have been broken down into pieces. The convenience of a substantial relationship to the element makes it easier to build factories to produce the views, and makes it easier to keep track of the view pieces as the model is changed and the view must be changed to reflect the model. Simple views therefore represent an Element directly and complex views do not.

A view has the following responsibilities:

Participate in layout.

The view has a setSize method which is like doLayout and setSize in Component combined. The view has a preferenceChanged method which is like invalidate in Component except that one can invalidate just one axis and the child requesting the change is identified.

A View expresses the size that it would like to be in terms of three values, a minimum, a preferred, and a maximum span. Layout in a view is can be done independently upon each axis. For a properly functioning View implementation, the minimum span will be <= the preferred span which in turn will be <= the maximum span.

The above text describes this graphic.

The minimum set of methods for layout are:

The setSize method should be prepared to be called a number of times (i.e. It may be called even if the size didn't change). The setSize method is generally called to make sure the View layout is complete prior to trying to perform an operation on it that requires an up-to-date layout. A view's size should always be set to a value within the minimum and maximum span specified by that view. Additionally, the view must always call the preferenceChanged method on the parent if it has changed the values for the layout it would like, and expects the parent to honor. The parent View is not required to recognize a change until the preferenceChanged has been sent. This allows parent View implementations to cache the child requirements if desired. The calling sequence looks something like the following:

Sample calling sequence between parent view and child view: 
       setSize, getMinimum, getPreferred, getMaximum, getAlignment, setSize

The exact calling sequence is up to the layout functionality of the parent view (if the view has any children). The view may collect the preferences of the children prior to determining what it will give each child, or it might iteratively update the children one at a time.

Render a portion of the model.

This is done in the paint method, which is pretty much like a component paint method. Views are expected to potentially populate a fairly large tree. A View has the following semantics for rendering:

The methods for rendering are:

Translate between the model and view coordinate systems.

Because the view objects are produced from a factory and therefore cannot necessarily be counted upon to be in a particular pattern, one must be able to perform translation to properly locate spatial representation of the model. The methods for doing this are:

The layout must be valid prior to attempting to make the translation. The translation is not valid, and must not be attempted while changes are being broadcasted from the model via a DocumentEvent.

Respond to changes from the model.

If the overall view is represented by many pieces (which is the best situation if one want to be able to change the view and write the least amount of new code), it would be impractical to have a huge number of DocumentListeners. If each view listened to the model, only a few would actually be interested in the changes broadcasted at any given time. Since the model has no knowledge of views, it has no way to filter the broadcast of change information. The view hierarchy itself is instead responsible for propagating the change information. At any level in the view hierarchy, that view knows enough about its children to best distribute the change information further. Changes are therefore broadcasted starting from the root of the view hierarchy. The methods for doing this are:


Field Summary
static int BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight
          The weight to indicate a view is a bad break opportunity for the purpose of formatting.
static int ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight
          The weight to indicate a view supports breaking, and this represents a very attractive place to break.
static int ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight
          The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them.
static int GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight
          The weight to indicate a view supports breaking, but better opportunities probably exist.
static int X_AXIS sample code for javax.swing.text.View.X_AXIS definition code for javax.swing.text.View.X_AXIS
          Axis for format/break operations.
static int Y_AXIS sample code for javax.swing.text.View.Y_AXIS definition code for javax.swing.text.View.Y_AXIS
          Axis for format/break operations.
 
Fields inherited from interface javax.swing.SwingConstants sample code for javax.swing.SwingConstants definition code for javax.swing.SwingConstants
BOTTOM sample code for javax.swing.SwingConstants.BOTTOM definition code for javax.swing.SwingConstants.BOTTOM , CENTER sample code for javax.swing.SwingConstants.CENTER definition code for javax.swing.SwingConstants.CENTER , EAST sample code for javax.swing.SwingConstants.EAST definition code for javax.swing.SwingConstants.EAST , HORIZONTAL sample code for javax.swing.SwingConstants.HORIZONTAL definition code for javax.swing.SwingConstants.HORIZONTAL , LEADING sample code for javax.swing.SwingConstants.LEADING definition code for javax.swing.SwingConstants.LEADING , LEFT sample code for javax.swing.SwingConstants.LEFT definition code for javax.swing.SwingConstants.LEFT , NEXT sample code for javax.swing.SwingConstants.NEXT definition code for javax.swing.SwingConstants.NEXT , NORTH sample code for javax.swing.SwingConstants.NORTH definition code for javax.swing.SwingConstants.NORTH , NORTH_EAST sample code for javax.swing.SwingConstants.NORTH_EAST definition code for javax.swing.SwingConstants.NORTH_EAST , NORTH_WEST sample code for javax.swing.SwingConstants.NORTH_WEST definition code for javax.swing.SwingConstants.NORTH_WEST , PREVIOUS sample code for javax.swing.SwingConstants.PREVIOUS definition code for javax.swing.SwingConstants.PREVIOUS , RIGHT sample code for javax.swing.SwingConstants.RIGHT definition code for javax.swing.SwingConstants.RIGHT , SOUTH sample code for javax.swing.SwingConstants.SOUTH definition code for javax.swing.SwingConstants.SOUTH , SOUTH_EAST sample code for javax.swing.SwingConstants.SOUTH_EAST definition code for javax.swing.SwingConstants.SOUTH_EAST , SOUTH_WEST sample code for javax.swing.SwingConstants.SOUTH_WEST definition code for javax.swing.SwingConstants.SOUTH_WEST , TOP sample code for javax.swing.SwingConstants.TOP definition code for javax.swing.SwingConstants.TOP , TRAILING sample code for javax.swing.SwingConstants.TRAILING definition code for javax.swing.SwingConstants.TRAILING , VERTICAL sample code for javax.swing.SwingConstants.VERTICAL definition code for javax.swing.SwingConstants.VERTICAL , WEST sample code for javax.swing.SwingConstants.WEST definition code for javax.swing.SwingConstants.WEST
 
Constructor Summary
View sample code for javax.swing.text.View.View(javax.swing.text.Element) definition code for javax.swing.text.View.View(javax.swing.text.Element) (Element sample code for javax.swing.text.Element definition code for javax.swing.text.Element  elem)
          Creates a new View object.
 
Method Summary
 void append sample code for javax.swing.text.View.append(javax.swing.text.View) definition code for javax.swing.text.View.append(javax.swing.text.View) (View sample code for javax.swing.text.View definition code for javax.swing.text.View  v)
          Appends a single child view.
 View sample code for javax.swing.text.View definition code for javax.swing.text.View breakView sample code for javax.swing.text.View.breakView(int, int, float, float) definition code for javax.swing.text.View.breakView(int, int, float, float) (int axis, int offset, float pos, float len)
          Tries to break this view on the given axis.
 void changedUpdate sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Gives notification from the document that attributes were changed in a location that this view is responsible for.
 View sample code for javax.swing.text.View definition code for javax.swing.text.View createFragment sample code for javax.swing.text.View.createFragment(int, int) definition code for javax.swing.text.View.createFragment(int, int) (int p0, int p1)
          Creates a view that represents a portion of the element.
protected  void forwardUpdate sample code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent.ElementChange sample code for javax.swing.event.DocumentEvent.ElementChange definition code for javax.swing.event.DocumentEvent.ElementChange  ec, DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Forwards the given DocumentEvent to the child views that need to be notified of the change to the model.
protected  void forwardUpdateToView sample code for javax.swing.text.View.forwardUpdateToView(javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdateToView(javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (View sample code for javax.swing.text.View definition code for javax.swing.text.View  v, DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Forwards the DocumentEvent to the give child view.
 float getAlignment sample code for javax.swing.text.View.getAlignment(int) definition code for javax.swing.text.View.getAlignment(int) (int axis)
          Determines the desired alignment for this view along an axis.
 AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet getAttributes sample code for javax.swing.text.View.getAttributes() definition code for javax.swing.text.View.getAttributes() ()
          Fetches the attributes to use when rendering.
 int getBreakWeight sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float) (int axis, float pos, float len)
          Determines how attractive a break opportunity in this view is.
 Shape sample code for java.awt.Shape definition code for java.awt.Shape getChildAllocation sample code for javax.swing.text.View.getChildAllocation(int, java.awt.Shape) definition code for javax.swing.text.View.getChildAllocation(int, java.awt.Shape) (int index, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
          Fetches the allocation for the given child view.
 Container sample code for java.awt.Container definition code for java.awt.Container getContainer sample code for javax.swing.text.View.getContainer() definition code for javax.swing.text.View.getContainer() ()
          Fetches the container hosting the view.
 Document sample code for javax.swing.text.Document definition code for javax.swing.text.Document getDocument sample code for javax.swing.text.View.getDocument() definition code for javax.swing.text.View.getDocument() ()
          Fetches the model associated with the view.
 Element sample code for javax.swing.text.Element definition code for javax.swing.text.Element getElement sample code for javax.swing.text.View.getElement() definition code for javax.swing.text.View.getElement() ()
          Fetches the structural portion of the subject that this view is mapped to.
 int getEndOffset sample code for javax.swing.text.View.getEndOffset() definition code for javax.swing.text.View.getEndOffset() ()
          Fetches the portion of the model for which this view is responsible.
 Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics getGraphics sample code for javax.swing.text.View.getGraphics() definition code for javax.swing.text.View.getGraphics() ()
          Fetch a Graphics for rendering.
 float getMaximumSpan sample code for javax.swing.text.View.getMaximumSpan(int) definition code for javax.swing.text.View.getMaximumSpan(int) (int axis)
          Determines the maximum span for this view along an axis.
 float getMinimumSpan sample code for javax.swing.text.View.getMinimumSpan(int) definition code for javax.swing.text.View.getMinimumSpan(int) (int axis)
          Determines the minimum span for this view along an axis.
 int getNextVisualPositionFrom sample code for javax.swing.text.View.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) (int pos, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, int direction, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasRet)
          Provides a way to determine the next visually represented model location at which one might place a caret.
 View sample code for javax.swing.text.View definition code for javax.swing.text.View getParent sample code for javax.swing.text.View.getParent() definition code for javax.swing.text.View.getParent() ()
          Returns the parent of the view.
abstract  float getPreferredSpan sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int) (int axis)
          Determines the preferred span for this view along an axis.
 int getResizeWeight sample code for javax.swing.text.View.getResizeWeight(int) definition code for javax.swing.text.View.getResizeWeight(int) (int axis)
          Determines the resizability of the view along the given axis.
 int getStartOffset sample code for javax.swing.text.View.getStartOffset() definition code for javax.swing.text.View.getStartOffset() ()
          Fetches the portion of the model for which this view is responsible.
 String sample code for java.lang.String definition code for java.lang.String getToolTipText sample code for javax.swing.text.View.getToolTipText(float, float, java.awt.Shape) definition code for javax.swing.text.View.getToolTipText(float, float, java.awt.Shape) (float x, float y, Shape sample code for java.awt.Shape definition code for java.awt.Shape  allocation)
          Returns the tooltip text at the specified location.
 View sample code for javax.swing.text.View definition code for javax.swing.text.View getView sample code for javax.swing.text.View.getView(int) definition code for javax.swing.text.View.getView(int) (int n)
          Gets the nth child view.
 int getViewCount sample code for javax.swing.text.View.getViewCount() definition code for javax.swing.text.View.getViewCount() ()
          Returns the number of views in this view.
 ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory getViewFactory sample code for javax.swing.text.View.getViewFactory() definition code for javax.swing.text.View.getViewFactory() ()
          Fetches the ViewFactory implementation that is feeding the view hierarchy.
 int getViewIndex sample code for javax.swing.text.View.getViewIndex(float, float, java.awt.Shape) definition code for javax.swing.text.View.getViewIndex(float, float, java.awt.Shape) (float x, float y, Shape sample code for java.awt.Shape definition code for java.awt.Shape  allocation)
          Returns the child view index representing the given position in the view.
 int getViewIndex sample code for javax.swing.text.View.getViewIndex(int, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.getViewIndex(int, javax.swing.text.Position.Bias) (int pos, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b)
          Returns the child view index representing the given position in the model.
 void insert sample code for javax.swing.text.View.insert(int, javax.swing.text.View) definition code for javax.swing.text.View.insert(int, javax.swing.text.View) (int offs, View sample code for javax.swing.text.View definition code for javax.swing.text.View  v)
          Inserts a single child view.
 void insertUpdate sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Gives notification that something was inserted into the document in a location that this view is responsible for.
 boolean isVisible sample code for javax.swing.text.View.isVisible() definition code for javax.swing.text.View.isVisible() ()
          Returns a boolean that indicates whether the view is visible or not.
 Shape sample code for java.awt.Shape definition code for java.awt.Shape modelToView sample code for javax.swing.text.View.modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape) definition code for javax.swing.text.View.modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape) (int p0, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b0, int p1, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b1, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
          Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.
 Shape sample code for java.awt.Shape definition code for java.awt.Shape modelToView sample code for javax.swing.text.View.modelToView(int, java.awt.Shape) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape) (int pos, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
          Deprecated.  
abstract  Shape sample code for java.awt.Shape definition code for java.awt.Shape modelToView sample code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) (int pos, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b)
          Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.
abstract  void paint sample code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) (Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  g, Shape sample code for java.awt.Shape definition code for java.awt.Shape  allocation)
          Renders using the given rendering surface and area on that surface.
 void preferenceChanged sample code for javax.swing.text.View.preferenceChanged(javax.swing.text.View, boolean, boolean) definition code for javax.swing.text.View.preferenceChanged(javax.swing.text.View, boolean, boolean) (View sample code for javax.swing.text.View definition code for javax.swing.text.View  child, boolean width, boolean height)
          Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.
 void remove sample code for javax.swing.text.View.remove(int) definition code for javax.swing.text.View.remove(int) (int i)
          Removes one of the children at the given position.
 void removeAll sample code for javax.swing.text.View.removeAll() definition code for javax.swing.text.View.removeAll() ()
          Removes all of the children.
 void removeUpdate sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Gives notification that something was removed from the document in a location that this view is responsible for.
 void replace sample code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) definition code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) (int offset, int length, View sample code for javax.swing.text.View definition code for javax.swing.text.View [] views)
          Replaces child views.
 void setParent sample code for javax.swing.text.View.setParent(javax.swing.text.View) definition code for javax.swing.text.View.setParent(javax.swing.text.View) (View sample code for javax.swing.text.View definition code for javax.swing.text.View  parent)
          Establishes the parent view for this view.
 void setSize sample code for javax.swing.text.View.setSize(float, float) definition code for javax.swing.text.View.setSize(float, float) (float width, float height)
          Sets the size of the view.
protected  boolean updateChildren sample code for javax.swing.text.View.updateChildren(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.updateChildren(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory) (DocumentEvent.ElementChange sample code for javax.swing.event.DocumentEvent.ElementChange definition code for javax.swing.event.DocumentEvent.ElementChange  ec, DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.
protected  void updateLayout sample code for javax.swing.text.View.updateLayout(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape) definition code for javax.swing.text.View.updateLayout(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape) (DocumentEvent.ElementChange sample code for javax.swing.event.DocumentEvent.ElementChange definition code for javax.swing.event.DocumentEvent.ElementChange  ec, DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
          Updates the layout in response to receiving notification of change from the model.
 int viewToModel sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape) (float x, float y, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
          Deprecated.  
abstract  int viewToModel sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) (float x, float y, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasReturn)
          Provides a mapping from the view coordinate space to the logical coordinate space of the model.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight

public static final int BadBreakWeight
The weight to indicate a view is a bad break opportunity for the purpose of formatting. This value indicates that no attempt should be made to break the view into fragments as the view has not been written to support fragmenting.

See Also:
getBreakWeight(int, float, float) sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float) , GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight , ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight , ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight , Constant Field Values

GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight

public static final int GoodBreakWeight
The weight to indicate a view supports breaking, but better opportunities probably exist.

See Also:
getBreakWeight(int, float, float) sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float) , BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight , ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight , ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight , Constant Field Values

ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight

public static final int ExcellentBreakWeight
The weight to indicate a view supports breaking, and this represents a very attractive place to break.

See Also:
getBreakWeight(int, float, float) sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float) , BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight , GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight , ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight , Constant Field Values

ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight

public static final int ForcedBreakWeight
The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them.

See Also:
getBreakWeight(int, float, float) sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float) , BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight , GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight , ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight , Constant Field Values

X_AXIS sample code for javax.swing.text.View.X_AXIS

public static final int X_AXIS
Axis for format/break operations.

See Also:
Constant Field Values

Y_AXIS sample code for javax.swing.text.View.Y_AXIS

public static final int Y_AXIS
Axis for format/break operations.

See Also:
Constant Field Values
Constructor Detail

View sample code for javax.swing.text.View(javax.swing.text.Element) definition code for javax.swing.text.View(javax.swing.text.Element)

public View(Element sample code for javax.swing.text.Element definition code for javax.swing.text.Element  elem)
Creates a new View object.

Parameters:
elem - the Element to represent
Method Detail

getParent sample code for javax.swing.text.View.getParent() definition code for javax.swing.text.View.getParent()

public View sample code for javax.swing.text.View definition code for javax.swing.text.View  getParent()
Returns the parent of the view.

Returns:
the parent, or null if none exists

isVisible sample code for javax.swing.text.View.isVisible() definition code for javax.swing.text.View.isVisible()

public boolean isVisible()
Returns a boolean that indicates whether the view is visible or not. By default all views are visible.

Returns:
always returns true

getPreferredSpan sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int)

public abstract float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
the span the view would like to be rendered into. 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
See Also:
getPreferredSpan(int) sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int)

getMinimumSpan sample code for javax.swing.text.View.getMinimumSpan(int) definition code for javax.swing.text.View.getMinimumSpan(int)

public float getMinimumSpan(int axis)
Determines the minimum span for this view along an axis.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
the minimum span the view can be rendered into
See Also:
getPreferredSpan(int) sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int)

getMaximumSpan sample code for javax.swing.text.View.getMaximumSpan(int) definition code for javax.swing.text.View.getMaximumSpan(int)

public float getMaximumSpan(int axis)
Determines the maximum span for this view along an axis.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
the maximum span the view can be rendered into
See Also:
getPreferredSpan(int) sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int)

preferenceChanged sample code for javax.swing.text.View.preferenceChanged(javax.swing.text.View, boolean, boolean) definition code for javax.swing.text.View.preferenceChanged(javax.swing.text.View, boolean, boolean)

public void preferenceChanged(View sample code for javax.swing.text.View definition code for javax.swing.text.View  child,
                              boolean width,
                              boolean height)
Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout. By default this just propagates upward to the next parent. The root view will call revalidate on the associated text component.

Parameters:
child - the child view
width - true if the width preference has changed
height - true if the height preference has changed
See Also:
JComponent.revalidate() sample code for javax.swing.JComponent.revalidate() definition code for javax.swing.JComponent.revalidate()

getAlignment sample code for javax.swing.text.View.getAlignment(int) definition code for javax.swing.text.View.getAlignment(int)

public float getAlignment(int axis)
Determines the desired alignment for this view along an axis. The desired alignment is returned. This should be a value >= 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 center of the view.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
the value 0.5

paint sample code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape)

public abstract void paint(Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  g,
                           Shape sample code for java.awt.Shape definition code for java.awt.Shape  allocation)
Renders using the given rendering surface and area on that surface. The view may need to do layout and create child views to enable itself to render into the given allocation.

Parameters:
g - the rendering surface to use
allocation - the allocated region to render into
See Also:
paint(java.awt.Graphics, java.awt.Shape) sample code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape)

setParent sample code for javax.swing.text.View.setParent(javax.swing.text.View) definition code for javax.swing.text.View.setParent(javax.swing.text.View)

public void setParent(View sample code for javax.swing.text.View definition code for javax.swing.text.View  parent)
Establishes the parent view for this view. This is guaranteed to be called before any other methods if the parent view is functioning properly. This is also the last method called, since it is called to indicate the view has been removed from the hierarchy as well. When this method is called to set the parent to null, this method does the same for each of its children, propogating the notification that they have been disconnected from the view tree. If this is reimplemented, super.setParent() should be called.

Parameters:
parent - the new parent, or null if the view is being removed from a parent

getViewCount sample code for javax.swing.text.View.getViewCount() definition code for javax.swing.text.View.getViewCount()

public int getViewCount()
Returns the number of views in this view. Since the default is to not be a composite view this returns 0.

Returns:
the number of views >= 0
See Also:
getViewCount() sample code for javax.swing.text.View.getViewCount() definition code for javax.swing.text.View.getViewCount()

getView sample code for javax.swing.text.View.getView(int) definition code for javax.swing.text.View.getView(int)

public View sample code for javax.swing.text.View definition code for javax.swing.text.View  getView(int n)
Gets the nth child view. Since there are no children by default, this returns null.

Parameters:
n - the number of the view to get, >= 0 && < getViewCount()
Returns:
the view

removeAll sample code for javax.swing.text.View.removeAll() definition code for javax.swing.text.View.removeAll()

public void removeAll()
Removes all of the children. This is a convenience call to replace.

Since:
1.3

remove sample code for javax.swing.text.View.remove(int) definition code for javax.swing.text.View.remove(int)

public void remove(int i)
Removes one of the children at the given position. This is a convenience call to replace.

Since:
1.3

insert sample code for javax.swing.text.View.insert(int, javax.swing.text.View) definition code for javax.swing.text.View.insert(int, javax.swing.text.View)

public void insert(int offs,
                   View sample code for javax.swing.text.View definition code for javax.swing.text.View  v)
Inserts a single child view. This is a convenience call to replace.

Parameters:
offs - the offset of the view to insert before >= 0
v - the view
Since:
1.3
See Also:
replace(int, int, javax.swing.text.View[]) sample code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) definition code for javax.swing.text.View.replace(int, int, javax.swing.text.View[])

append sample code for javax.swing.text.View.append(javax.swing.text.View) definition code for javax.swing.text.View.append(javax.swing.text.View)

public void append(View sample code for javax.swing.text.View definition code for javax.swing.text.View  v)
Appends a single child view. This is a convenience call to replace.

Parameters:
v - the view
Since:
1.3
See Also:
replace(int, int, javax.swing.text.View[]) sample code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) definition code for javax.swing.text.View.replace(int, int, javax.swing.text.View[])

replace sample code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) definition code for javax.swing.text.View.replace(int, int, javax.swing.text.View[])

public void replace(int offset,
                    int length,
                    View sample code for javax.swing.text.View definition code for javax.swing.text.View [] views)
Replaces child views. If there are no views to remove this acts as an insert. If there are no views to add this acts as a remove. Views being removed will have the parent set to null, and the internal reference to them removed so that they can be garbage collected. This is implemented to do nothing, because by default a view has no children.

Parameters:
offset - the starting index into the child views to insert the new views. This should be a value >= 0 and <= getViewCount
length - the number of existing child views to remove This should be a value >= 0 and <= (getViewCount() - offset).
views - the child views to add. This value can be null to indicate no children are being added (useful to remove).
Since:
1.3

getViewIndex sample code for javax.swing.text.View.getViewIndex(int, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.getViewIndex(int, javax.swing.text.Position.Bias)

public int getViewIndex(int pos,
                        Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b)
Returns the child view index representing the given position in the model. By default a view has no children so this is implemented to return -1 to indicate there is no valid child index for any position.

Parameters:
pos - the position >= 0
Returns:
index of the view representing the given position, or -1 if no view represents that position
Since:
1.3

getChildAllocation sample code for javax.swing.text.View.getChildAllocation(int, java.awt.Shape) definition code for javax.swing.text.View.getChildAllocation(int, java.awt.Shape)

public Shape sample code for java.awt.Shape definition code for java.awt.Shape  getChildAllocation(int index,
                                Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
Fetches the allocation for the given child view. This enables finding out where various views are located, without assuming how the views store their location. This returns null since the default is to not have any child views.

Parameters:
index - the index of the child, >= 0 && < getViewCount()
a - the allocation to this view
Returns:
the allocation to the child

getNextVisualPositionFrom sample code for javax.swing.text.View.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

public int getNextVisualPositionFrom(int pos,
                                     Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b,
                                     Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                                     int direction,
                                     Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasRet)
                              throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException 
Provides a way to determine the next visually represented model location at which one might place a caret. Some views may not be visible, 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.

Parameters:
pos - the position to convert >= 0
a - the allocated region in which to render
direction - the direction from the current position that can be thought of as the arrow keys typically found on a keyboard. This will be one of the following values:
  • SwingConstants.WEST
  • SwingConstants.EAST
  • SwingConstants.NORTH
  • SwingConstants.SOUTH
Returns:
the location within the model that best represents the next location visual position
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if direction doesn't have one of the legal values above

modelToView sample code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

public abstract Shape sample code for java.awt.Shape definition code for java.awt.Shape  modelToView(int pos,
                                  Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                                  Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b)
                           throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException 
Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.

Parameters:
pos - the position of the desired character (>=0)
a - the area of the view, which encompasses the requested character
b - the bias toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; b will have one of these values:
  • Position.Bias.Forward
  • Position.Bias.Backward
Returns:
the bounding box, in view coordinate space, of the character at the specified position
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the specified position does not represent a valid location in the associated document
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if b is not one of the legal Position.Bias values listed above
See Also:
viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

modelToView sample code for javax.swing.text.View.modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape) definition code for javax.swing.text.View.modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape)

public Shape sample code for java.awt.Shape definition code for java.awt.Shape  modelToView(int p0,
                         Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b0,
                         int p1,
                         Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b1,
                         Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
                  throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException 
Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space. The specified region is created as a union of the first and last character positions.

Parameters:
p0 - the position of the first character (>=0)
b0 - the bias of the first character position, toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; b0 will have one of these values:
  • Position.Bias.Forward
  • Position.Bias.Backward
p1 - the position of the last character (>=0)
b1 - the bias for the second character position, defined one of the legal values shown above
a - the area of the view, which encompasses the requested region
Returns:
the bounding box which is a union of the region specified by the first and last character positions
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the given position does not represent a valid location in the associated document
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if b0 or b1 are not one of the legal Position.Bias values listed above
See Also:
viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

viewToModel sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

public abstract int viewToModel(float x,
                                float y,
                                Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                                Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasReturn)
Provides a mapping from the view coordinate space to the logical coordinate space of the model. The biasReturn argument will be filled in to indicate that the point given is closer to the next character in the model or the previous character in the model.

Parameters:
x - the X coordinate >= 0
y - the Y coordinate >= 0
a - the allocated region in which to render
Returns:
the location within the model that best represents the given point in the view >= 0. The biasReturn argument will be filled in to indicate that the point given is closer to the next character in the model or the previous character in the model.

insertUpdate sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public void insertUpdate(DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                         Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                         ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Gives notification that something was inserted into the document in a location that this view is responsible for. To reduce the burden to subclasses, this functionality is spread out into the following calls that subclasses can reimplement:
  1. updateChildren is called if there were any changes to the element this view is responsible for. If this view has child views that are represent the child elements, then this method should do whatever is necessary to make sure the child views correctly represent the model.
  2. forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
  3. updateLayout is called to give the view a chance to either repair its layout, to reschedule layout, or do nothing.

Parameters:
e - the change information from the associated document
a - the current allocation of the view
f - the factory to use to rebuild if the view has children
See Also:
insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

removeUpdate sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public void removeUpdate(DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                         Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                         ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Gives notification that something was removed from the document in a location that this view is responsible for. To reduce the burden to subclasses, this functionality is spread out into the following calls that subclasses can reimplement:
  1. updateChildren is called if there were any changes to the element this view is responsible for. If this view has child views that are represent the child elements, then this method should do whatever is necessary to make sure the child views correctly represent the model.
  2. forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
  3. updateLayout is called to give the view a chance to either repair its layout, to reschedule layout, or do nothing.

Parameters:
e - the change information from the associated document
a - the current allocation of the view
f - the factory to use to rebuild if the view has children
See Also:
removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

changedUpdate sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public void changedUpdate(DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                          Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                          ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Gives notification from the document that attributes were changed in a location that this view is responsible for. To reduce the burden to subclasses, this functionality is spread out into the following calls that subclasses can reimplement:
  1. updateChildren is called if there were any changes to the element this view is responsible for. If this view has child views that are represent the child elements, then this method should do whatever is necessary to make sure the child views correctly represent the model.
  2. forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
  3. updateLayout is called to give the view a chance to either repair its layout, to reschedule layout, or do nothing.

Parameters:
e - the change information from the associated document
a - the current allocation of the view
f - the factory to use to rebuild if the view has children
See Also:
changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

getDocument sample code for javax.swing.text.View.getDocument() definition code for javax.swing.text.View.getDocument()

public Document sample code for javax.swing.text.Document definition code for javax.swing.text.Document  getDocument()
Fetches the model associated with the view.

Returns:
the view model, null if none
See Also:
getDocument() sample code for javax.swing.text.View.getDocument() definition code for javax.swing.text.View.getDocument()

getStartOffset sample code for javax.swing.text.View.getStartOffset() definition code for javax.swing.text.View.getStartOffset()

public int getStartOffset()
Fetches the portion of the model for which this view is responsible.

Returns:
the starting offset into the model >= 0
See Also:
getStartOffset() sample code for javax.swing.text.View.getStartOffset() definition code for javax.swing.text.View.getStartOffset()

getEndOffset sample code for javax.swing.text.View.getEndOffset() definition code for javax.swing.text.View.getEndOffset()

public int getEndOffset()
Fetches the portion of the model for which this view is responsible.

Returns:
the ending offset into the model >= 0
See Also:
getEndOffset() sample code for javax.swing.text.View.getEndOffset() definition code for javax.swing.text.View.getEndOffset()

getElement sample code for javax.swing.text.View.getElement() definition code for javax.swing.text.View.getElement()

public Element sample code for javax.swing.text.Element definition code for javax.swing.text.Element  getElement()
Fetches the structural portion of the subject that this view is mapped to. The view may not be responsible for the entire portion of the element.

Returns:
the subject
See Also:
getElement() sample code for javax.swing.text.View.getElement() definition code for javax.swing.text.View.getElement()

getGraphics sample code for javax.swing.text.View.getGraphics() definition code for javax.swing.text.View.getGraphics()

public Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  getGraphics()
Fetch a Graphics for rendering. This can be used to determine font characteristics, and will be different for a print view than a component view.

Returns:
a Graphics object for rendering
Since:
1.3

getAttributes sample code for javax.swing.text.View.getAttributes() definition code for javax.swing.text.View.getAttributes()

public AttributeSet sample code for javax.swing.text.AttributeSet definition code for javax.swing.text.AttributeSet  getAttributes()
Fetches the attributes to use when rendering. By default this simply returns the attributes of the associated element. This method should be used rather than using the element directly to obtain access to the attributes to allow view-specific attributes to be mixed in or to allow the view to have view-specific conversion of attributes by subclasses. Each view should document what attributes it recognizes for the purpose of rendering or layout, and should always access them through the AttributeSet returned by this method.


breakView sample code for javax.swing.text.View.breakView(int, int, float, float) definition code for javax.swing.text.View.breakView(int, int, float, float)

public View sample code for javax.swing.text.View definition code for javax.swing.text.View  breakView(int axis,
                      int offset,
                      float pos,
                      float len)
Tries to break this view on the given axis. This is called by views that try to do formatting of their children. For example, a view of a paragraph will typically try to place its children into row and views representing chunks of text can sometimes be broken down into smaller pieces.

This is implemented to return the view itself, which represents the default behavior on not being breakable. If the view does support breaking, the starting offset of the view returned should be the given offset, and the end offset should be less than or equal to the end offset of the view being broken.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
offset - the location in the document model that a broken fragment would occupy >= 0. This would be the starting offset of the fragment returned
pos - the position along the axis that the broken view would occupy >= 0. This may be useful for things like tab calculations
len - specifies the distance along the axis where a potential break is desired >= 0
Returns:
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 returned.
See Also:
ParagraphView sample code for javax.swing.text.ParagraphView definition code for javax.swing.text.ParagraphView

createFragment sample code for javax.swing.text.View.createFragment(int, int) definition code for javax.swing.text.View.createFragment(int, int)

public View sample code for javax.swing.text.View definition code for javax.swing.text.View  createFragment(int p0,
                           int p1)
Creates a view that represents a portion of the element. This is potentially useful during formatting operations for taking measurements of fragments of the view. If the view doesn't support fragmenting (the default), it should return itself.

Parameters:
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.
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.
Returns:
the view fragment, or itself if the view doesn't support breaking into fragments
See Also:
LabelView sample code for javax.swing.text.LabelView definition code for javax.swing.text.LabelView

getBreakWeight sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float)

public int getBreakWeight(int axis,
                          float pos,
                          float len)
Determines how attractive a break opportunity in this view is. This can be used for determining which view is the most attractive to call breakView on in the process of formatting. A view that represents text that has whitespace in it might be more attractive than a view that has no whitespace, for example. The higher the weight, the more attractive the break. A value equal to or lower than BadBreakWeight should not be considered for a break. A value greater than or equal to ForcedBreakWeight should be broken.

This is implemented to provide the default behavior of returning BadBreakWeight unless the length is greater than the length of the view in which case the entire view represents the fragment. Unless a view has been written to support breaking behavior, it is not attractive to try and break the view. An example of a view that does support breaking is LabelView. An example of a view that uses break weight is ParagraphView.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
pos - the potential location of the start of the broken view >= 0. This may be useful for calculating tab positions
len - specifies the relative length from pos where a potential break is desired >= 0
Returns:
the weight, which should be a value between ForcedBreakWeight and BadBreakWeight
See Also:
LabelView sample code for javax.swing.text.LabelView definition code for javax.swing.text.LabelView , ParagraphView sample code for javax.swing.text.ParagraphView definition code for javax.swing.text.ParagraphView , BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight , GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight , ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight , ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight

getResizeWeight sample code for javax.swing.text.View.getResizeWeight(int) definition code for javax.swing.text.View.getResizeWeight(int)

public int getResizeWeight(int axis)
Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.

Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
the weight

setSize sample code for javax.swing.text.View.setSize(float, float) definition code for javax.swing.text.View.setSize(float, float)

public void setSize(float width,
                    float height)
Sets the size of the view. This should cause layout of the view along the given axis, if it has any layout duties.

Parameters:
width - the width >= 0
height - the height >= 0

getContainer sample code for javax.swing.text.View.getContainer() definition code for javax.swing.text.View.getContainer()

public Container sample code for java.awt.Container definition code for java.awt.Container  getContainer()
Fetches the container hosting the view. This is useful for things like scheduling a repaint, finding out the host components font, etc. The default implementation of this is to forward the query to the parent view.

Returns:
the container, null if none

getViewFactory sample code for javax.swing.text.View.getViewFactory() definition code for javax.swing.text.View.getViewFactory()

public ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  getViewFactory()
Fetches the ViewFactory implementation that is feeding the view hierarchy. Normally the views are given this as an argument to updates from the model when they are most likely to need the factory, but this method serves to provide it at other times.

Returns:
the factory, null if none

getToolTipText sample code for javax.swing.text.View.getToolTipText(float, float, java.awt.Shape) definition code for javax.swing.text.View.getToolTipText(float, float, java.awt.Shape)

public String sample code for java.lang.String definition code for java.lang.String  getToolTipText(float x,
                             float y,
                             Shape sample code for java.awt.Shape definition code for java.awt.Shape  allocation)
Returns the tooltip text at the specified location. The default implementation returns the value from the child View identified by the passed in location.

Since:
1.4
See Also:
JTextComponent.getToolTipText(java.awt.event.MouseEvent) sample code for javax.swing.text.JTextComponent.getToolTipText(java.awt.event.MouseEvent) definition code for javax.swing.text.JTextComponent.getToolTipText(java.awt.event.MouseEvent)

getViewIndex sample code for javax.swing.text.View.getViewIndex(float, float, java.awt.Shape) definition code for javax.swing.text.View.getViewIndex(float, float, java.awt.Shape)

public int getViewIndex(float x,
                        float y,
                        Shape sample code for java.awt.Shape definition code for java.awt.Shape  allocation)
Returns the child view index representing the given position in the view. This iterates over all the children returning the first with a bounds that contains x, y.

Parameters:
x - the x coordinate
y - the y coordinate
allocation - current allocation of the View.
Returns:
index of the view representing the given location, or -1 if no view represents that position
Since:
1.4

updateChildren sample code for javax.swing.text.View.updateChildren(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.updateChildren(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory)

protected boolean updateChildren(DocumentEvent.ElementChange sample code for javax.swing.event.DocumentEvent.ElementChange definition code for javax.swing.event.DocumentEvent.ElementChange  ec,
                                 DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                                 ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for. This is implemented to assume the child views are directly responsible for the child elements of the element this view represents. The ViewFactory is used to create child views for each element specified as added in the ElementChange, starting at the index specified in the given ElementChange. The number of child views representing the removed elements specified are removed.

Parameters:
ec - the change information for the element this view is responsible for. This should not be null if this method gets called
e - the change information from the associated document
f - the factory to use to build child views
Returns:
whether or not the child views represent the child elements of the element this view is responsible for. Some views create children that represent a portion of the element they are responsible for, and should return false. This information is used to determine if views in the range of the added elements should be forwarded to or not
Since:
1.3
See Also:
insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

forwardUpdate sample code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

protected void forwardUpdate(DocumentEvent.ElementChange sample code for javax.swing.event.DocumentEvent.ElementChange definition code for javax.swing.event.DocumentEvent.ElementChange  ec,
                             DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                             Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                             ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Forwards the given DocumentEvent to the child views that need to be notified of the change to the model. If there were changes to the element this view is responsible for, that should be considered when forwarding (i.e. new child views should not get notified).

Parameters:
ec - changes to the element this view is responsible for (may be null if there were no changes).
e - the change information from the associated document
a - the current allocation of the view
f - the factory to use to rebuild if the view has children
Since:
1.3
See Also:
insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

forwardUpdateToView sample code for javax.swing.text.View.forwardUpdateToView(javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdateToView(javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

protected void forwardUpdateToView(View sample code for javax.swing.text.View definition code for javax.swing.text.View  v,
                                   DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                                   Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                                   ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Forwards the DocumentEvent to the give child view. This simply messages the view with a call to insertUpdate, removeUpdate, or changedUpdate depending upon the type of the event. This is called by forwardUpdate to forward the event to children that need it.

Parameters:
v - the child view to forward the event to
e - the change information from the associated document
a - the current allocation of the view
f - the factory to use to rebuild if the view has children
Since:
1.3
See Also:
forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

updateLayout sample code for javax.swing.text.View.updateLayout(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape) definition code for javax.swing.text.View.updateLayout(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape)

protected void updateLayout(DocumentEvent.ElementChange sample code for javax.swing.event.DocumentEvent.ElementChange definition code for javax.swing.event.DocumentEvent.ElementChange  ec,
                            DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                            Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
Updates the layout in response to receiving notification of change from the model. This is implemented to call preferenceChanged to reschedule a new layout if the ElementChange record is not null.

Parameters:
ec - changes to the element this view is responsible for (may be null if there were no changes)
e - the change information from the associated document
a - the current allocation of the view
Since:
1.3
See Also:
insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

modelToView sample code for javax.swing.text.View.modelToView(int, java.awt.Shape) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape)

@Deprecated
public Shape sample code for java.awt.Shape definition code for java.awt.Shape  modelToView(int pos,
                                    Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
                  throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException 
Deprecated. 

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. This is implemented to default the bias to Position.Bias.Forward which was previously implied.

Parameters:
pos - the position to convert >= 0
a - the allocated region in which to render
Returns:
the bounding box of the given position is returned
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the given position does not represent a valid location in the associated document
See Also:
modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) sample code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

viewToModel sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape)

@Deprecated
public int viewToModel(float x,
                                  float y,
                                  Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
Deprecated. 

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:
x - the X coordinate >= 0
y - the Y coordinate >= 0
a - the allocated region in which to render
Returns:
the location within the model that best represents the given point in the view >= 0
See Also:
viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])