javax.swing.text.GlyphView — clojure-interop/javax.swing 1.0.5

A GlyphView is a styled chunk of text that represents a view mapped over an element in the text model. This view is generally responsible for displaying text glyphs using character level attributes in some way. An implementation of the GlyphPainter class is used to do the actual rendering and model/view translations. This separates rendering from layout and management of the association with the model.

The view supports breaking for the purpose of formatting. The fragments produced by breaking share the view that has primary responsibility for the element (i.e. they are nested classes and carry only a small amount of state of their own) so they can share its resources.

Since this view represents text that may have tabs embedded in it, it implements the TabableView interface. Tabs will only be expanded if this view is embedded in a container that does tab expansion. ParagraphView is an example of a container that does tab expansion.

->glyph-view clj

(->glyph-view elem)

Constructor.

Constructs a new view wrapped on an element.

elem - the element - javax.swing.text.Element

break-view clj

(break-view this axis p-0 pos len)

Breaks this view on the given axis at the given length. This is implemented to attempt to break on a whitespace location, and returns a fragment with the whitespace at the end. If a whitespace location can't be found, the nearest character is used.

axis - may be either View.X_AXIS or View.Y_AXIS - int p-0 - the location in the model where the fragment should start it's representation >= 0. - int pos - the position along the axis that the broken view would occupy >= 0. This may be useful for things like tab calculations. - float len - specifies the distance along the axis where a potential break is desired >= 0. - float

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. - javax.swing.text.View

changed-update clj

(changed-update this e a f)

Gives notification from the document that attributes were changed in a location that this view is responsible for. This is implemented to call preferenceChanged along both the horizontal and vertical axis.

e - the change information from the associated document - javax.swing.event.DocumentEvent a - the current allocation of the view - java.awt.Shape f - the factory to use to rebuild if the view has children - javax.swing.text.ViewFactory

create-fragment clj

(create-fragment this p-0 p-1)

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.

This view does support fragmenting. It is implemented to return a nested class that shares state in this view representing only a portion of the view.

p-0 - the starting offset >= 0. This should be a value greater or equal to the element starting offset and less than the element ending offset. - int p-1 - 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. - int

returns: the view fragment, or itself if the view doesn't support breaking into fragments - javax.swing.text.View

get-alignment clj

(get-alignment this axis)

Determines the desired alignment for this view along an axis. For the label, the alignment is along the font baseline for the y axis, and the superclasses alignment along the x axis.

axis - may be either View.X_AXIS or View.Y_AXIS - int

returns: the desired alignment. This should be a value between 0.0 and 1.0 inclusive, 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. - float

get-background clj

(get-background this)

Fetch the background color to use to render the glyphs. If there is no background color, null should be returned. This is implemented to call StyledDocument.getBackground if the associated document is a styled document, otherwise it returns null.

returns: java.awt.Color

get-break-weight clj

(get-break-weight this axis pos 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. The higher the weight, the more attractive the break. A value equal to or lower than View.BadBreakWeight should not be considered for a break. A value greater than or equal to View.ForcedBreakWeight should be broken.

This is implemented to forward to the superclass for the Y_AXIS. Along the X_AXIS the following values may be returned.

View.ExcellentBreakWeight if there is whitespace proceeding the desired break location. View.BadBreakWeight if the desired break location results in a break location of the starting offset. View.GoodBreakWeight if the other conditions don't occur.

This will normally result in the behavior of breaking on a whitespace location if one can be found, otherwise breaking between characters.

axis - may be either View.X_AXIS or View.Y_AXIS - int pos - the potential location of the start of the broken view >= 0. This may be useful for calculating tab positions. - float len - specifies the relative length from pos where a potential break is desired >= 0. - float

returns: the weight, which should be a value between View.ForcedBreakWeight and View.BadBreakWeight. - int

get-end-offset clj

(get-end-offset this)

Fetches the portion of the model that this view is responsible for.

returns: the ending offset into the model - int

get-font clj

(get-font this)

Fetch the font that the glyphs should be based upon. This is implemented to call StyledDocument.getFont if the associated document is a StyledDocument. If the associated document is not a StyledDocument, the associated components font is used. If there is no associated component, null is returned.

returns: java.awt.Font

get-foreground clj

(get-foreground this)

Fetch the foreground color to use to render the glyphs. If there is no foreground color, null should be returned. This is implemented to call StyledDocument.getBackground if the associated document is a StyledDocument. If the associated document is not a StyledDocument, the associated components foreground color is used. If there is no associated component, null is returned.

returns: java.awt.Color

get-glyph-painter clj

(get-glyph-painter this)

Fetch the currently installed glyph painter. If a painter has not yet been installed, and a default was not yet needed, null is returned.

returns: javax.swing.text.GlyphView$GlyphPainter

get-minimum-span clj

(get-minimum-span this axis)

Determines the minimum span for this view along an axis.

This implementation returns the longest non-breakable area within the view as a minimum span for View.X_AXIS.

axis - may be either View.X_AXIS or View.Y_AXIS - int

returns: the minimum span the view can be rendered into - float

throws: java.lang.IllegalArgumentException - if the axis parameter is invalid

get-next-visual-position-from clj

(get-next-visual-position-from this pos b a direction bias-ret)

Provides a way to determine the next visually represented model location that 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. This method enables specifying a position to convert within the range of >=0. If the value is -1, a position will be calculated automatically. If the value < -1, the BadLocationException will be thrown.

pos - the position to convert - int b - javax.swing.text.Position$Bias a - the allocated region to render into - java.awt.Shape direction - the direction from the current position that can be thought of as the arrow keys typically found on a keyboard. This may be SwingConstants.WEST, SwingConstants.EAST, SwingConstants.NORTH, or SwingConstants.SOUTH. - int bias-ret - javax.swing.text.Position$Bias[]

returns: the location within the model that best represents the next location visual position. - int

throws: javax.swing.text.BadLocationException - the given position is not a valid position within the document

get-partial-span clj

(get-partial-span this p-0 p-1)

Determines the span along the same axis as tab expansion for a portion of the view. This is intended for use by the TabExpander for cases where the tab expansion involves aligning the portion of text that doesn't have whitespace relative to the tab stop. There is therefore an assumption that the range given does not contain tabs.

This method can be called while servicing the getTabbedSpan or getPreferredSize. It has to arrange for its own text buffer to make the measurements.

p-0 - the starting document offset >= 0 - int p-1 - the ending document offset >= p0 - int

returns: the span >= 0 - float

get-preferred-span clj

(get-preferred-span this axis)

Determines the preferred span for this view along an axis.

axis - may be either View.X_AXIS or View.Y_AXIS - int

returns: the span the view would like to be rendered into >= 0. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view. - float

get-start-offset clj

(get-start-offset this)

Fetches the portion of the model that this view is responsible for.

returns: the starting offset into the model - int

get-tab-expander clj

(get-tab-expander this)

Fetch the TabExpander to use if tabs are present in this view.

returns: javax.swing.text.TabExpander

get-tabbed-span clj

(get-tabbed-span this x e)

Determines the desired span when using the given tab expansion implementation.

x - the position the view would be located at for the purpose of tab expansion >= 0. - float e - how to expand the tabs when encountered. - javax.swing.text.TabExpander

returns: the desired span >= 0 - float

get-text clj

(get-text this p-0 p-1)

Fetch a reference to the text that occupies the given range. This is normally used by the GlyphPainter to determine what characters it should render glyphs for.

p-0 - the starting document offset >= 0 - int p-1 - the ending document offset >= p0 - int

returns: the Segment containing the text - javax.swing.text.Segment

insert-update clj

(insert-update this e a f)

Gives notification that something was inserted into the document in a location that this view is responsible for. This is implemented to call preferenceChanged along the axis the glyphs are rendered.

e - the change information from the associated document - javax.swing.event.DocumentEvent a - the current allocation of the view - java.awt.Shape f - the factory to use to rebuild if the view has children - javax.swing.text.ViewFactory

model-to-view clj

(model-to-view this pos a b)

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

pos - the position to convert >= 0 - int a - the allocated region to render into - java.awt.Shape b - either Position.Bias.Forward or Position.Bias.Backward - javax.swing.text.Position$Bias

returns: the bounding box of the given position - java.awt.Shape

throws: javax.swing.text.BadLocationException - if the given position does not represent a valid location in the associated document

paint clj

(paint this g a)

Renders a portion of a text style run.

g - the rendering surface to use - java.awt.Graphics a - the allocated region to render into - java.awt.Shape

remove-update clj

(remove-update this e a f)

Gives notification that something was removed from the document in a location that this view is responsible for. This is implemented to call preferenceChanged along the axis the glyphs are rendered.

e - the change information from the associated document - javax.swing.event.DocumentEvent a - the current allocation of the view - java.awt.Shape f - the factory to use to rebuild if the view has children - javax.swing.text.ViewFactory

set-glyph-painter clj

(set-glyph-painter this p)

Sets the painter to use for rendering glyphs.

p - javax.swing.text.GlyphView$GlyphPainter

strike-through? clj

(strike-through? this)

Determine if the glyphs should have a strikethrough line. If true, a line should be drawn through the center of the glyphs.

returns: boolean

subscript? clj

(subscript? this)

Determine if the glyphs should be rendered as superscript.

returns: boolean

superscript? clj

(superscript? this)

Determine if the glyphs should be rendered as subscript.

returns: boolean

underline? clj

(underline? this)

Determine if the glyphs should be underlined. If true, an underline should be drawn through the baseline.

returns: boolean

view-to-model clj

(view-to-model this x y a bias-return)

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

x - the X coordinate >= 0 - float y - the Y coordinate >= 0 - float a - the allocated region to render into - java.awt.Shape bias-return - either Position.Bias.Forward or Position.Bias.Backward is returned as the zero-th element of this array - javax.swing.text.Position$Bias[]

returns: the location within the model that best represents the given point of view >= 0 - int