- java.lang.Object
-
- javax.swing.text.View
-
- javax.swing.text.CompositeView
-
- javax.swing.text.BoxView
-
- javax.swing.text.WrappedPlainView
-
- All Implemented Interfaces:
- SwingConstants, TabExpander
public class WrappedPlainView extends BoxView implements TabExpander
View of plain text (text with only one font and color) that does line-wrapping. This view expects that its associated element has child elements that represent the lines it should be wrapping. It is implemented as a vertical box that contains logical line views. The logical line views are nested classes that render the logical line as multiple physical line if the logical line is too wide to fit within the allocation. The line views draw upon the outer class for its state to reduce their memory requirements.The line views do all of their rendering through the
drawLine
method which in turn does all of its rendering through thedrawSelectedText
anddrawUnselectedText
methods. This enables subclasses to easily specialize the rendering without concern for the layout aspects.- See Also:
View
-
-
Field Summary
-
Fields inherited from class javax.swing.text.View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
-
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
-
Constructor Summary
Constructors Constructor and Description WrappedPlainView(Element elem)
Creates a new WrappedPlainView.WrappedPlainView(Element elem, boolean wordWrap)
Creates a new WrappedPlainView.
-
Method Summary
Methods Modifier and Type Method and Description protected int
calculateBreakPosition(int p0, int p1)
This is called by the nested wrapped line views to determine the break location.void
changedUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification from the document that attributes were changed in a location that this view is responsible for.protected void
drawLine(int p0, int p1, Graphics g, int x, int y)
Renders a line of text, suppressing whitespace at the end and expanding any tabs.protected int
drawSelectedText(Graphics g, int x, int y, int p0, int p1)
Renders the given range in the model as selected text.protected int
drawUnselectedText(Graphics g, int x, int y, int p0, int p1)
Renders the given range in the model as normal unselected text.protected Segment
getLineBuffer()
Gives access to a buffer that can be used to fetch text from the associated document.float
getMaximumSpan(int axis)
Determines the maximum span for this view along an axis.float
getMinimumSpan(int axis)
Determines the minimum span for this view along an axis.float
getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.protected int
getTabSize()
Returns the tab size set for the document, defaulting to 8.void
insertUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification that something was inserted into the document in a location that this view is responsible for.protected void
loadChildren(ViewFactory f)
Loads all of the children to initialize the view.float
nextTabStop(float x, int tabOffset)
Returns the next tab stop position after a given reference position.void
paint(Graphics g, Shape a)
Renders using the given rendering surface and area on that surface.void
removeUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification that something was removed from the document in a location that this view is responsible for.void
setSize(float width, float height)
Sets the size of the view.-
Methods inherited from class javax.swing.text.BoxView
baselineLayout, baselineRequirements, calculateMajorAxisRequirements, calculateMinorAxisRequirements, childAllocation, flipEastAndWestAtEnds, forwardUpdate, getAlignment, getAxis, getChildAllocation, getHeight, getOffset, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layout, layoutChanged, layoutMajorAxis, layoutMinorAxis, modelToView, paintChild, preferenceChanged, replace, setAxis, viewToModel
-
Methods inherited from class javax.swing.text.CompositeView
getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, getViewIndexAtPosition, modelToView, setInsets, setParagraphInsets, setParent
-
Methods inherited from class javax.swing.text.View
append, breakView, createFragment, forwardUpdateToView, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, isVisible, modelToView, remove, removeAll, updateChildren, updateLayout, viewToModel
-
-
-
-
Constructor Detail
-
WrappedPlainView
public WrappedPlainView(Element elem)
Creates a new WrappedPlainView. Lines will be wrapped on character boundaries.- Parameters:
elem
- the element underlying the view
-
WrappedPlainView
public WrappedPlainView(Element elem, boolean wordWrap)
Creates a new WrappedPlainView. Lines can be wrapped on either character or word boundaries depending upon the setting of the wordWrap parameter.- Parameters:
elem
- the element underlying the viewwordWrap
- should lines be wrapped on word boundaries?
-
-
Method Detail
-
getTabSize
protected int getTabSize()
Returns the tab size set for the document, defaulting to 8.- Returns:
- the tab size
-
drawLine
protected void drawLine(int p0, int p1, Graphics g, int x, int y)
Renders a line of text, suppressing whitespace at the end and expanding any tabs. This is implemented to make calls to the methodsdrawUnselectedText
anddrawSelectedText
so that the way selected and unselected text are rendered can be customized.- Parameters:
p0
- the starting document location to use >= 0p1
- the ending document location to use >= p1g
- the graphics contextx
- the starting X position >= 0y
- the starting Y position >= 0- See Also:
drawUnselectedText(java.awt.Graphics, int, int, int, int)
,drawSelectedText(java.awt.Graphics, int, int, int, int)
-
drawUnselectedText
protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException
Renders the given range in the model as normal unselected text.- Parameters:
g
- the graphics contextx
- the starting X coordinate >= 0y
- the starting Y coordinate >= 0p0
- the beginning position in the model >= 0p1
- the ending position in the model >= p0- Returns:
- the X location of the end of the range >= 0
- Throws:
BadLocationException
- if the range is invalid
-
drawSelectedText
protected int drawSelectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException
Renders the given range in the model as selected text. This is implemented to render the text in the color specified in the hosting component. It assumes the highlighter will render the selected background.- Parameters:
g
- the graphics contextx
- the starting X coordinate >= 0y
- the starting Y coordinate >= 0p0
- the beginning position in the model >= 0p1
- the ending position in the model >= p0- Returns:
- the location of the end of the range.
- Throws:
BadLocationException
- if the range is invalid
-
getLineBuffer
protected final Segment getLineBuffer()
Gives access to a buffer that can be used to fetch text from the associated document.- Returns:
- the buffer
-
calculateBreakPosition
protected int calculateBreakPosition(int p0, int p1)
This is called by the nested wrapped line views to determine the break location. This can be reimplemented to alter the breaking behavior. It will either break at word or character boundaries depending upon the break argument given at construction.
-
loadChildren
protected void loadChildren(ViewFactory f)
Loads all of the children to initialize the view. This is called by thesetParent
method. Subclasses can reimplement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.- Overrides:
loadChildren
in classCompositeView
- Parameters:
f
- the view factory- See Also:
CompositeView.setParent(javax.swing.text.View)
-
nextTabStop
public float nextTabStop(float x, int tabOffset)
Returns the next tab stop position after a given reference position. This implementation does not support things like centering so it ignores the tabOffset argument.- Specified by:
nextTabStop
in interfaceTabExpander
- Parameters:
x
- the current position >= 0tabOffset
- the position within the text stream that the tab occurred at >= 0.- Returns:
- the tab stop, measured in points >= 0
-
paint
public void paint(Graphics g, Shape a)
Renders using the given rendering surface and area on that surface. This is implemented to stash the selection positions, selection colors, and font metrics for the nested lines to use.- Overrides:
paint
in classBoxView
- Parameters:
g
- the rendering surface to usea
- the allocated region to render into- See Also:
View.paint(java.awt.Graphics, java.awt.Shape)
-
setSize
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.
-
getPreferredSpan
public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).- Overrides:
getPreferredSpan
in classBoxView
- 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:
View.getPreferredSpan(int)
-
getMinimumSpan
public float getMinimumSpan(int axis)
Determines the minimum span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).- Overrides:
getMinimumSpan
in classBoxView
- 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:
View.getMinimumSpan(int)
-
getMaximumSpan
public float getMaximumSpan(int axis)
Determines the maximum span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).- Overrides:
getMaximumSpan
in classBoxView
- 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:
View.getMaximumSpan(int)
-
insertUpdate
public void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification that something was inserted into the document in a location that this view is responsible for. This is implemented to simply update the children.- Overrides:
insertUpdate
in classView
- Parameters:
e
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- See Also:
View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)
-
removeUpdate
public void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification that something was removed from the document in a location that this view is responsible for. This is implemented to simply update the children.- Overrides:
removeUpdate
in classView
- Parameters:
e
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- See Also:
View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)
-
changedUpdate
public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification from the document that attributes were changed in a location that this view is responsible for.- Overrides:
changedUpdate
in classView
- Parameters:
e
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- See Also:
View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 16:22:07 Cette version de la page est en cache (à la date du 05/11/2024 16:22:07) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/text/WrappedPlainView.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.