Liking cljdoc? Tell your friends :D

javax.swing.text.IconView

Icon decorator that implements the view interface. The entire element is used to represent the icon. This acts as a gateway from the display-only View implementations to interactive lightweight icons (that is, it allows icons to be embedded into the View hierarchy. The parent of the icon is the container that is handed out by the associated view factory.

Icon decorator that implements the view interface.  The
entire element is used to represent the icon.  This acts
as a gateway from the display-only View implementations to
interactive lightweight icons (that is, it allows icons
to be embedded into the View hierarchy.  The parent of the icon
is the container that is handed out by the associated view
factory.
raw docstring

->icon-viewclj

(->icon-view elem)

Constructor.

Creates a new icon view that represents an element.

elem - the element to create a view for - javax.swing.text.Element

Constructor.

Creates a new icon view that represents an element.

elem - the element to create a view for - `javax.swing.text.Element`
raw docstring

get-alignmentclj

(get-alignment this axis)

Determines the desired alignment for this view along an axis. This is implemented to give the alignment to the bottom of the icon along the y axis, and the default along the x axis.

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

returns: the desired alignment >= 0.0f && <= 1.0f. This should be a value between 0.0 and 1.0 where 0 indicates alignment at the origin and 1.0 indicates alignment to the full span away from the origin. An alignment of 0.5 would be the center of the view. - float

Determines the desired alignment for this view along an
 axis.  This is implemented to give the alignment to the
 bottom of the icon along the y axis, and the default
 along the x axis.

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

returns: the desired alignment >= 0.0f && <= 1.0f.  This should be
   a value between 0.0 and 1.0 where 0 indicates alignment at the
   origin and 1.0 indicates alignment to the full span
   away from the origin.  An alignment of 0.5 would be the
   center of the view. - `float`
raw docstring

get-preferred-spanclj

(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 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

throws: java.lang.IllegalArgumentException - for an invalid 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
           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`

throws: java.lang.IllegalArgumentException - for an invalid axis
raw docstring

model-to-viewclj

(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 - 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 - 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

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 - 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 - `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
raw docstring

paintclj

(paint this g a)

Paints the icon. The real paint behavior occurs naturally from the association that the icon has with its parent container (the same container hosting this view), so this simply allows us to position the icon properly relative to the view. Since the coordinate system for the view is simply the parent containers, positioning the child icon is easy.

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

Paints the icon.
 The real paint behavior occurs naturally from the association
 that the icon has with its parent container (the same
 container hosting this view), so this simply allows us to
 position the icon properly relative to the view.  Since
 the coordinate system for the view is simply the parent
 containers, positioning the child icon is easy.

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

view-to-modelclj

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

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 - javax.swing.text.Position$Bias[]

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

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 - `javax.swing.text.Position$Bias[]`

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

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close