Class View

public static final int BadBreakWeight

Field Value:

0

public static final int ExcellentBreakWeight

Field Value:

2000

public static final int ForcedBreakWeight

Field Value:

3000

public static final int GoodBreakWeight

Field Value:

1000

public static final int X_AXIS

Field Value:

0

public static final int Y_AXIS

Field Value:

1

public View(Element elem)

Creates a new View instance.

Parameters:

elem - an Element value

public void append(View view)

public View breakView(int axis,
                      int offset,
                      float pos,
                      float len)

public void changedUpdate(DocumentEvent ev,
                          Shape shape,
                          ViewFactory vf)

Receive notification about a change update to the text model. The default implementation of this method does the following:

• Call updateChildren(DocumentEvent.ElementChange,DocumentEvent,ViewFactory) if the element that this view is responsible for has changed. This makes sure that the children can correctly represent the model.
• Call forwardUpdate(DocumentEvent.ElementChange,DocumentEvent,Shape,ViewFactory). This forwards the DocumentEvent to the child views.
• Call updateLayout(DocumentEvent.ElementChange,DocumentEvent,Shape). Gives the view a chance to either repair its layout, reschedule layout or do nothing at all.

Parameters:

ev - the DocumentEvent that describes the change

shape - the shape of the view

vf - the ViewFactory for creating child views

public View createFragment(int p0,
                           int p1)

protected void dump()

Dumps the complete View hierarchy. This method can be used for debugging purposes.

protected void forwardUpdate(DocumentEvent.ElementChange ec,
                             DocumentEvent ev,
                             Shape shape,
                             ViewFactory vf)

Forwards the DocumentEvent to child views that need to get notified of the change to the model. This calles forwardUpdateToView(View,DocumentEvent,Shape,ViewFactory) for each View that must be forwarded to. If ec is not null (this means there have been structural changes to the element that this view is responsible for) this method should recognize this and don't notify newly added child views.

Parameters:

ec - the ElementChange describing the element changes (may be null if there were no changes)

ev - the DocumentEvent describing the changes to the model

shape - the current allocation of the view

vf - the ViewFactory used to create new Views

Since:

1.3

protected void forwardUpdateToView(View view,
                                   DocumentEvent ev,
                                   Shape shape,
                                   ViewFactory vf)

Forwards an update event to the given child view. This calls insertUpdate(DocumentEvent,Shape,ViewFactory), removeUpdate(DocumentEvent,Shape,ViewFactory) or changedUpdate(DocumentEvent,Shape,ViewFactory), depending on the type of document event.

Parameters:

view - the View to forward the event to

ev - the DocumentEvent to forward

shape - the current allocation of the View

vf - the ViewFactory used to create new Views

Since:

1.3

public float getAlignment(int axis)

Returns the alignment of this view along the baseline of the parent view. An alignment of 0.0 will align this view with the left edge along the baseline, an alignment of 0.5 will align it centered to the baseline, an alignment of 1.0 will align the right edge along the baseline. The default implementation returns 0.5 unconditionally.

Parameters:

axis - the axis

Returns:

the alignment of this view along the parents baseline for the specified axis

public AttributeSet getAttributes()

public int getBreakWeight(int axis,
                          float pos,
                          float len)

public Shape getChildAllocation(int index,
                                Shape a)

public Container getContainer()

public Document getDocument()

public Element getElement()

public int getEndOffset()

public Graphics getGraphics()

Since:

1.3

public float getMaximumSpan(int axis)

Returns the maximum span along the specified axis. The default implementation will forward to getPreferredSpan(int) unless getResizeWeight(int) returns a value > 0, in which case this returns Integer.MIN_VALUE.

Parameters:

axis - the axis

Returns:

the maximum span along the specified axis

public float getMinimumSpan(int axis)

Returns the minimum span along the specified axis. The default implementation will forward to getPreferredSpan(int) unless getResizeWeight(int) returns a value > 0, in which case this returns 0.

Parameters:

axis - the axis

Returns:

the minimum span along the specified axis

public int getNextVisualPositionFrom(int pos,
                                     Position.Bias b,
                                     Shape a,
                                     int d,
                                     Position.Bias[] biasRet)
            throws BadLocationException

Returns the document position that is (visually) nearest to the given document position pos in the given direction d.

Parameters:

pos - the document position

b - the bias for pos

a - the allocation for this view

d - the direction, must be either SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.WEST or SwingConstants.EAST

biasRet - an array of Position.Bias that can hold at least one element, which is filled with the bias of the return position on method exit

Returns:

the document position that is (visually) nearest to the given document position pos in the given direction d

Throws:

BadLocationException - if pos is not a valid offset in the document model

IllegalArgumentException - if d is not a valid direction

public View getParent()

public abstract float getPreferredSpan(int axis)

Returns the preferred span along the specified axis. Normally the view is rendered with the span returned here if that is possible.

Parameters:

axis - the axis

Returns:

the preferred span along the specified axis

public int getResizeWeight(int axis)

Returns the resize weight of this view. A value of 0 or less means this view is not resizeable. Positive values make the view resizeable. The default implementation returns 0 unconditionally.

Parameters:

axis - the axis

Returns:

the resizability of this view along the specified axis

public int getStartOffset()

public String getToolTipText(float x,
                             float y,
                             Shape allocation)

Since:

1.4

public View getView(int index)

public int getViewCount()

public ViewFactory getViewFactory()

public int getViewIndex(float x,
                        float y,
                        Shape allocation)

Since:

1.4

public int getViewIndex(int pos,
                        Position.Bias b)

Since:

1.3

public void insert(int offset,
                   View view)

public void insertUpdate(DocumentEvent ev,
                         Shape shape,
                         ViewFactory vf)

Receive notification about an insert update to the text model. The default implementation of this method does the following:

• Call updateChildren(DocumentEvent.ElementChange,DocumentEvent,ViewFactory) if the element that this view is responsible for has changed. This makes sure that the children can correctly represent the model.
• Call forwardUpdate(DocumentEvent.ElementChange,DocumentEvent,Shape,ViewFactory). This forwards the DocumentEvent to the child views.
• Call updateLayout(DocumentEvent.ElementChange,DocumentEvent,Shape). Gives the view a chance to either repair its layout, reschedule layout or do nothing at all.

Parameters:

ev - the DocumentEvent that describes the change

shape - the shape of the view

vf - the ViewFactory for creating child views

public boolean isVisible()

public Shape modelToView(int pos,
                         Shape a)
            throws BadLocationException

Deprecated. Use modelToView(int,Shape,Position.Bias) instead.

Maps a position in the document into the coordinate space of the View. The output rectangle usually reflects the font height but has a width of zero. This method is deprecated and calls modelToView(int,Position.Bias,int,Position.Bias,Shape) with a bias of Position.Bias.Forward.

Parameters:

pos - the position of the character in the model

a - the area that is occupied by the view

Returns:

a rectangle that gives the location of the document position inside the view coordinate space

Throws:

BadLocationException - if pos is invalid

public abstract Shape modelToView(int pos,
                                  Shape a,
                                  Position.Bias b)
            throws BadLocationException

Maps a position in the document into the coordinate space of the View. The output rectangle usually reflects the font height but has a width of zero.

Parameters:

pos - the position of the character in the model

a - the area that is occupied by the view

b - either Position.Bias.Forward or Position.Bias.Backward depending on the preferred direction bias. If null this defaults to Position.Bias.Forward

Returns:

a rectangle that gives the location of the document position inside the view coordinate space

Throws:

BadLocationException - if pos is invalid

IllegalArgumentException - if b is not one of the above listed valid values

public Shape modelToView(int p1,
                         Position.Bias b1,
                         int p2,
                         Position.Bias b2,
                         Shape a)
            throws BadLocationException

Maps a region in the document into the coordinate space of the View.

Parameters:

p1 - the beginning position inside the document

b1 - the direction bias for the beginning position

p2 - the end position inside the document

b2 - the direction bias for the end position

a - the area that is occupied by the view

Returns:

a rectangle that gives the span of the document region inside the view coordinate space

Throws:

BadLocationException - if p1 or p2 are invalid

IllegalArgumentException - if b1 or b2 is not one of the above listed valid values

public abstract void paint(Graphics g,
                           Shape s)

public void preferenceChanged(View child,
                              boolean width,
                              boolean height)

public void remove(int index)

public void removeAll()

public void removeUpdate(DocumentEvent ev,
                         Shape shape,
                         ViewFactory vf)

Receive notification about a remove update to the text model. The default implementation of this method does the following:

• Call updateChildren(DocumentEvent.ElementChange,DocumentEvent,ViewFactory) if the element that this view is responsible for has changed. This makes sure that the children can correctly represent the model.
• Call forwardUpdate(DocumentEvent.ElementChange,DocumentEvent,Shape,ViewFactory). This forwards the DocumentEvent to the child views.
• Call updateLayout(DocumentEvent.ElementChange,DocumentEvent,Shape). Gives the view a chance to either repair its layout, reschedule layout or do nothing at all.

Parameters:

ev - the DocumentEvent that describes the change

shape - the shape of the view

vf - the ViewFactory for creating child views

public void replace(int offset,
                    int length,
                    View[] views)

Replaces a couple of child views with new child views. If length == 0 then this is a simple insertion, if views == null this only removes some child views.

Parameters:

offset - the offset at which to replace

length - the number of child views to be removed

views - the new views to be inserted, may be null

public void setParent(View parent)

Sets the parent for this view. This is the first method that is beeing called on a view to setup the view hierarchy. This is also the last method beeing called when the view is disconnected from the view hierarchy, in this case parent is null. If parent is null, a call to this method also calls setParent on the children, thus disconnecting them from the view hierarchy. That means that super must be called when this method is overridden.

Parameters:

parent - the parent to set, null when this view is beeing disconnected from the view hierarchy

public void setSize(float width,
                    float height)

protected boolean updateChildren(DocumentEvent.ElementChange ec,
                                 DocumentEvent ev,
                                 ViewFactory vf)

Updates the list of children that is returned by getView(int) and getViewCount(). Element that are specified as beeing added in the ElementChange record are assigned a view for using the ViewFactory. Views of Elements that are specified as beeing removed are removed from the list.

Parameters:

ec - the ElementChange record that describes the change of the element

ev - the DocumentEvent describing the change of the document model

vf - the ViewFactory to use for creating new views

Returns:

whether or not the child views represent the child elements of the element that this view is responsible for. Some views may create views that are responsible only for parts of the element that they are responsible for and should then return false.

Since:

1.3

protected void updateLayout(DocumentEvent.ElementChange ec,
                            DocumentEvent ev,
                            Shape shape)

Updates the layout.

Parameters:

ec - the ElementChange that describes the changes to the element

ev - the DocumentEvent that describes the changes to the model

shape - the current allocation for this view

Since:

1.3

public int viewToModel(float x,
                       float y,
                       Shape a)

Deprecated. Use viewToModel(float,float,Shape,Position.Bias[]) instead.

Maps coordinates from the View's space into a position in the document model. This method is deprecated and only there for compatibility.

Parameters:

x - the x coordinate in the view space

y - the y coordinate in the view space

a - the allocation of this View

Returns:

the position in the document that corresponds to the screen coordinates x, y

public abstract int viewToModel(float x,
                                float y,
                                Shape a,
                                Position.Bias[] b)

Maps coordinates from the View's space into a position in the document model.

Parameters:

x - the x coordinate in the view space

y - the y coordinate in the view space

a - the allocation of this View

b - the bias to use

Returns:

the position in the document that corresponds to the screen coordinates x, y