Liking cljdoc? Tell your friends :D

jdk.awt.font.GraphicAttribute

This class is used with the CHAR_REPLACEMENT attribute.

The GraphicAttribute class represents a graphic embedded in text. Clients subclass this class to implement their own char replacement graphics. Clients wishing to embed shapes and images in text need not subclass this class. Instead, clients can use the ShapeGraphicAttribute and ImageGraphicAttribute classes.

Subclasses must ensure that their objects are immutable once they are constructed. Mutating a GraphicAttribute that is used in a TextLayout results in undefined behavior from the TextLayout.

This class is used with the CHAR_REPLACEMENT attribute.

The GraphicAttribute class represents a graphic embedded
in text. Clients subclass this class to implement their own char
replacement graphics.  Clients wishing to embed shapes and images in
text need not subclass this class.  Instead, clients can use the
ShapeGraphicAttribute and ImageGraphicAttribute
classes.

Subclasses must ensure that their objects are immutable once they
are constructed.  Mutating a GraphicAttribute that
is used in a TextLayout results in undefined behavior from the
TextLayout.
raw docstring

*-bottom-alignmentclj

Static Constant.

Aligns bottom of graphic to bottom of line.

type: int

Static Constant.

Aligns bottom of graphic to bottom of line.

type: int
raw docstring

*-center-baselineclj

Static Constant.

Aligns origin of graphic to center baseline of line.

type: int

Static Constant.

Aligns origin of graphic to center baseline of line.

type: int
raw docstring

*-hanging-baselineclj

Static Constant.

Aligns origin of graphic to hanging baseline of line.

type: int

Static Constant.

Aligns origin of graphic to hanging baseline of line.

type: int
raw docstring

*-roman-baselineclj

Static Constant.

Aligns origin of graphic to roman baseline of line.

type: int

Static Constant.

Aligns origin of graphic to roman baseline of line.

type: int
raw docstring

*-top-alignmentclj

Static Constant.

Aligns top of graphic to top of line.

type: int

Static Constant.

Aligns top of graphic to top of line.

type: int
raw docstring

drawclj

(draw this graphics x y)

Renders this GraphicAttribute at the specified location.

graphics - the Graphics2D into which to render the graphic - java.awt.Graphics2D x - the user-space X coordinate where the graphic is rendered - float y - the user-space Y coordinate where the graphic is rendered - float

Renders this GraphicAttribute at the specified
 location.

graphics - the Graphics2D into which to render the graphic - `java.awt.Graphics2D`
x - the user-space X coordinate where the graphic is rendered - `float`
y - the user-space Y coordinate where the graphic is rendered - `float`
raw docstring

get-advanceclj

(get-advance this)

Returns the advance of this GraphicAttribute. The GraphicAttribute object's advance is the distance from the point at which the graphic is rendered and the point where the next character or graphic is rendered. A graphic can be rendered beyond its advance

returns: the advance of this GraphicAttribute. - float

Returns the advance of this GraphicAttribute.  The
 GraphicAttribute object's advance is the distance
 from the point at which the graphic is rendered and the point where
 the next character or graphic is rendered.  A graphic can be
 rendered beyond its advance

returns: the advance of this GraphicAttribute. - `float`
raw docstring

get-alignmentclj

(get-alignment this)

Returns the alignment of this GraphicAttribute. Alignment can be to a particular baseline, or to the absolute top or bottom of a line.

returns: the alignment of this GraphicAttribute. - int

Returns the alignment of this GraphicAttribute.
 Alignment can be to a particular baseline, or to the absolute top
 or bottom of a line.

returns: the alignment of this GraphicAttribute. - `int`
raw docstring

get-ascentclj

(get-ascent this)

Returns the ascent of this GraphicAttribute. A graphic can be rendered above its ascent.

returns: the ascent of this GraphicAttribute. - float

Returns the ascent of this GraphicAttribute.  A
 graphic can be rendered above its ascent.

returns: the ascent of this GraphicAttribute. - `float`
raw docstring

get-boundsclj

(get-bounds this)

Returns a Rectangle2D that encloses all of the bits drawn by this GraphicAttribute relative to the rendering position. A graphic may be rendered beyond its origin, ascent, descent, or advance; but if it is, this method's implementation must indicate where the graphic is rendered. Default bounds is the rectangle (0, -ascent, advance, ascent+descent).

returns: a Rectangle2D that encloses all of the bits rendered by this GraphicAttribute. - java.awt.geom.Rectangle2D

Returns a Rectangle2D that encloses all of the
 bits drawn by this GraphicAttribute relative to the
 rendering position.
 A graphic may be rendered beyond its origin, ascent, descent,
 or advance;  but if it is, this method's implementation must
 indicate where the graphic is rendered.
 Default bounds is the rectangle (0, -ascent, advance, ascent+descent).

returns: a Rectangle2D that encloses all of the bits
 rendered by this GraphicAttribute. - `java.awt.geom.Rectangle2D`
raw docstring

get-descentclj

(get-descent this)

Returns the descent of this GraphicAttribute. A graphic can be rendered below its descent.

returns: the descent of this GraphicAttribute. - float

Returns the descent of this GraphicAttribute.  A
 graphic can be rendered below its descent.

returns: the descent of this GraphicAttribute. - `float`
raw docstring

get-justification-infoclj

(get-justification-info this)

Returns the justification information for this GraphicAttribute. Subclasses can override this method to provide different justification information.

returns: a GlyphJustificationInfo object that contains the justification information for this GraphicAttribute. - java.awt.font.GlyphJustificationInfo

Returns the justification information for this
 GraphicAttribute.  Subclasses
 can override this method to provide different justification
 information.

returns: a GlyphJustificationInfo object that contains the
 justification information for this GraphicAttribute. - `java.awt.font.GlyphJustificationInfo`
raw docstring

get-outlineclj

(get-outline this tx)

Return a Shape that represents the region that this GraphicAttribute renders. This is used when a TextLayout is requested to return the outline of the text. The (untransformed) shape must not extend outside the rectangular bounds returned by getBounds. The default implementation returns the rectangle returned by getBounds(), transformed by the provided AffineTransform if present.

tx - an optional AffineTransform to apply to the outline of this GraphicAttribute. This can be null. - java.awt.geom.AffineTransform

returns: a Shape representing this graphic attribute, suitable for stroking or filling. - java.awt.Shape

Return a Shape that represents the region that
 this GraphicAttribute renders.  This is used when a
 TextLayout is requested to return the outline of the text.
 The (untransformed) shape must not extend outside the rectangular
 bounds returned by getBounds.
 The default implementation returns the rectangle returned by
 getBounds(), transformed by the provided AffineTransform
 if present.

tx - an optional AffineTransform to apply to the outline of this GraphicAttribute. This can be null. - `java.awt.geom.AffineTransform`

returns: a Shape representing this graphic attribute,
   suitable for stroking or filling. - `java.awt.Shape`
raw docstring

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

× close