fr.inria.zvtm.glyphs

Class VTextLayout<T>

java.lang.Object

fr.inria.zvtm.glyphs.Glyph

fr.inria.zvtm.glyphs.ClosedShape

fr.inria.zvtm.glyphs.VText

fr.inria.zvtm.glyphs.VTextLayout<T>

All Implemented Interfaces:

Translucent, Cloneable

public class VTextLayout<T>
extends VText

Wrapper for an AWT TextLayout Inspired by examples taken from http://java.sun.com/developer/onlineTraining/Media/2DText/more.html

Author:

Emmanuel Pietriga

See Also:

VText, VTextOr

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSERTION_INDEX_UNDEFINED

Fields inherited from class fr.inria.zvtm.glyphs.VText

font, fontSize, lcoef, mainFont, oldcoef, oldlcoef, paddingX, paddingY, pc, scaleFactor, text, text_anchor, TEXT_ANCHOR_END, TEXT_ANCHOR_MIDDLE, TEXT_ANCHOR_START, zoomSensitive

Fields inherited from class fr.inria.zvtm.glyphs.ClosedShape

bColor, borderColor, cursorInsideFColor, HSVb

Fields inherited from class fr.inria.zvtm.glyphs.Glyph

alphaC, coef, color, cursorInsideColor, ENTERED_GLYPH, EXITED_GLYPH, fColor, HSV, NO_CURSOR_EVENT, orient, sensit, size, stickedTo, stroke, visible, vx, vy, vz

Fields inherited from interface fr.inria.zvtm.glyphs.Translucent

acO

Constructor Summary

Constructors

Constructor and Description
VTextLayout(double x, double y, int z, Color c, Color bkg, String t, short ta, Font f, float scale, float alpha)
VTextLayout(double x, double y, int z, Color c, String t)
VTextLayout(double x, double y, int z, Color c, String t, short ta, Font f)
VTextLayout(double x, double y, int z, Color c, String t, short ta, Font f, float scale)
VTextLayout(double x, double y, int z, Color c, String t, short ta, Font f, float scale, float alpha)
VTextLayout(String t)

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	containedInRegion(double wb, double nb, double eb, double sb, int i) Method used internally to find out if it is necessary to project and draw the glyph through a lens for a given camera.
boolean	coordInside(int jpx, int jpy, Camera c, double cvx, double cvy) Detect whether the given point is inside this glyph or not.
boolean	coordInsideP(int jpx, int jpy, Camera c) Not implemented for VText.
boolean	coordInsideV(double cvx, double cvy, Camera c) Detect whether the given point is inside this glyph or not.
void	draw(Graphics2D g, int vW, int vH, int i, Stroke stdS, AffineTransform stdT, int dx, int dy) Draw this glyph.
void	drawForLens(Graphics2D g, int vW, int vH, int i, Stroke stdS, AffineTransform stdT, int dx, int dy) Draw this glyph through a lens.
static void	editEvent(VTextLayout tl, KeyEvent e) Default implementation of common edit key events.
Point2D.Double	getBounds(int i) Get the width and height of the bounding box in virtual space.
int	getCaretPosition() Get the caret's position within the string.
static Color	getHighlightColor()
Shape	getJava2DShape() Get the Java2D Shape corresponding to this Glyph.
double	getSize() Get glyph's size (size of bounding circle).
static Color	getStrongCaretColor() Get the color used to paint the strong caret.
TextLayout	getTextLayout() Get the underlyoing AWT TextLayout instance.
static Color	getWeakCaretColor() Get the color used to paint the weak caret.
TextHitInfo	hitTestChar(int jpx, int jpy, Camera c) Returns a TextHitInfo corresponding to the specified point.
TextHitInfo	hitTestChar(int jpx, int jpy, Camera c, int dx, int dy) Returns a TextHitInfo corresponding to the specified point.
void	invalidate() Force computation of text's bounding box at next call to draw().
void	project(Camera c, Dimension d) Project glyph w.r.t a given camera's coordinate system, prior to actual painting.
void	projectForLens(Camera c, int lensWidth, int lensHeight, float lensMag, double lensx, double lensy) Project glyph w.r.t a given camera's coordinate system, prior to actual painting through a lens.
static void	setCaretColors(Color sc, Color wc) Set the strong and weak caret colors.
void	setCaretPosition(int ii) Set the caret's position within the string.
void	setFont(Font f) Change the Font used to display this specific text object.
static void	setHighlightColor(Color c)
void	setHighlightPosition(int firstEndPoint, int secondEndPoint)
void	updateCaretPosition(int jpx, int jpy, Camera c) Update the caret position to the point corresponding to the provided coordinates.
boolean	visibleInDisc(double dvx, double dvy, double dvr, Shape dvs, int camIndex, int jpx, int jpy, int dpr) Find out if a glyph is visible in a circular area.
boolean	visibleInRegion(double wb, double nb, double eb, double sb, int i) Method used internally to find out if it is necessary to project and draw this glyph for a given camera.

Methods inherited from class fr.inria.zvtm.glyphs.VText

addCamera, fillsView, getBorderColor, getFont, getMainFont, getOrient, getPadding, getScale, getText, getTextAnchor, getTextDisplayedAsSegCoef, highlight, initCams, isScaleIndependent, orientTo, removeCamera, reSize, setBorderColor, setMainFont, setPadding, setScale, setScaleIndependent, setText, setTextAnchor, setTextDisplayedAsSegCoef, sizeTo, usesSpecificFont, validBounds

Methods inherited from class fr.inria.zvtm.glyphs.ClosedShape

addHSVbColor, getDefaultBorderColor, getHSVbColor, isBorderDrawn, isFilled, setCursorInsideFillColor, setDrawBorder, setFilled, setHSVbColor

Methods inherited from class fr.inria.zvtm.glyphs.Glyph

addHSVColor, getBounds, getColor, getDefaultColor, getDefaultCursorInsideHighlightColor, getHSVColor, getLocation, getOwner, getStickedGlyphArray, getStroke, getTranslucencyValue, getType, getZindex, isSelected, isSensitive, isVisible, isVisibleThroughLens, move, moveTo, propagateMove, select, setColor, setCursorInsideHighlightColor, setDefaultCursorInsideHighlightColor, setHSVColor, setOwner, setSensitivity, setStroke, setTranslucencyValue, setType, setVisible, setZindex, stick, stickToGlyph, toString, unstick, unstickAllGlyphs, unstickAllGlyphs, unstickFromGlyph, visibleInViewport

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INSERTION_INDEX_UNDEFINED

public static final int INSERTION_INDEX_UNDEFINED

See Also:

Constant Field Values

Constructor Detail

VTextLayout

public VTextLayout(String t)

Parameters:

t - text string

VTextLayout

public VTextLayout(double x,
                   double y,
                   int z,
                   Color c,
                   String t)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

t - text string

VTextLayout

public VTextLayout(double x,
                   double y,
                   int z,
                   Color c,
                   String t,
                   short ta,
                   Font f)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

VTextLayout

public VTextLayout(double x,
                   double y,
                   int z,
                   Color c,
                   String t,
                   short ta,
                   Font f,
                   float scale)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

f - font used to render this TextLayout

scale - scaleFactor w.r.t original image size

VTextLayout

public VTextLayout(double x,
                   double y,
                   int z,
                   Color c,
                   String t,
                   short ta,
                   Font f,
                   float scale,
                   float alpha)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

f - font used to render this TextLayout

scale - scaleFactor w.r.t original image size

alpha - in [0;1.0]. 0 is fully transparent, 1 is opaque

VTextLayout

public VTextLayout(double x,
                   double y,
                   int z,
                   Color c,
                   Color bkg,
                   String t,
                   short ta,
                   Font f,
                   float scale,
                   float alpha)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

bkg - background color (null if not painted)

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

f - font used to render this TextLayout

scale - scaleFactor w.r.t original image size

alpha - in [0;1.0]. 0 is fully transparent, 1 is opaque

Method Detail

getTextLayout

public TextLayout getTextLayout()

Get the underlyoing AWT TextLayout instance.

Returns:

null if length of string is 0

setCaretColors

public static void setCaretColors(Color sc,
                                  Color wc)

Set the strong and weak caret colors.

Parameters:

sc - strong caret color

wc - weak caret color

getStrongCaretColor

public static Color getStrongCaretColor()

Get the color used to paint the strong caret.

getWeakCaretColor

public static Color getWeakCaretColor()

Get the color used to paint the weak caret.

setCaretPosition

public void setCaretPosition(int ii)

Set the caret's position within the string.

Parameters:

ii - insertion index (offset) in the TextLayout. Pass INSERTION_INDEX_UNDEFINED to remove the caret.

getCaretPosition

public int getCaretPosition()

Get the caret's position within the string.

Returns:

INSERTION_INDEX_UNDEFINED when caret is not set

hitTestChar

public TextHitInfo hitTestChar(int jpx,
                               int jpy,
                               Camera c)

Returns a TextHitInfo corresponding to the specified point. This method is a convenience overload of hitTestChar that uses the natural bounds of this TextLayout.

Parameters:

jpx - click coordinates, in JPanel coordinates.

jpy - click coordinates, in JPanel coordinates.

c - camera observing the TextLayout.

hitTestChar

public TextHitInfo hitTestChar(int jpx,
                               int jpy,
                               Camera c,
                               int dx,
                               int dy)

Returns a TextHitInfo corresponding to the specified point. This method is a convenience overload of hitTestChar that uses the natural bounds of this TextLayout.

Parameters:

jpx - click coordinates, in JPanel coordinates.

jpy - click coordinates, in JPanel coordinates.

c - camera observing the TextLayout.

dx - x-offest for hit test, typically used to give a Portal horizontal offset w.r.t the parent view's top left corner (JPanel coordinates).

dy - y-offest for hit test, typically used to give a Portal horizontal offset w.r.t the parent view's top left corner (JPanel coordinates).

Returns:

null if length of string is null

updateCaretPosition

public void updateCaretPosition(int jpx,
                                int jpy,
                                Camera c)

Update the caret position to the point corresponding to the provided coordinates.

Parameters:

jpx - click coordinates, in JPanel coordinates.

jpy - click coordinates, in JPanel coordinates.

c - camera observing the TextLayout.

setHighlightColor

public static void setHighlightColor(Color c)

getHighlightColor

public static Color getHighlightColor()

setHighlightPosition

public void setHighlightPosition(int firstEndPoint,
                                 int secondEndPoint)

invalidate

public void invalidate()

Force computation of text's bounding box at next call to draw().

Overrides:

invalidate in class VText

See Also:

VText.validBounds(int i), getBounds(int i)

getSize

public double getSize()

Get glyph's size (size of bounding circle). Will return 0 if bounds of this VText have never been validated (through painting).

Overrides:

getSize in class VText

See Also:

getBounds(int i), VText.validBounds(int i), invalidate()

visibleInRegion

public boolean visibleInRegion(double wb,
                               double nb,
                               double eb,
                               double sb,
                               int i)

Description copied from class: Glyph

Method used internally to find out if it is necessary to project and draw this glyph for a given camera.

Overrides:

visibleInRegion in class VText

Parameters:

wb - west region boundary (virtual space coordinates)

nb - north region boundary (virtual space coordinates)

eb - east region boundary (virtual space coordinates)

sb - south region boundary (virtual space coordinates)

i - camera index (useuful only for some glyph classes redefining this method)

Returns:

true if the glyph is currently visible in the region delimited by wb, nb, eb, sb, symbolising the region seen through a camera

containedInRegion

public boolean containedInRegion(double wb,
                                 double nb,
                                 double eb,
                                 double sb,
                                 int i)

Description copied from class: Glyph

Method used internally to find out if it is necessary to project and draw the glyph through a lens for a given camera.

Overrides:

containedInRegion in class VText

Parameters:

wb - west region boundary (virtual space coordinates)

nb - north region boundary (virtual space coordinates)

eb - east region boundary (virtual space coordinates)

sb - south region boundary (virtual space coordinates)

i - camera index (useuful only for some glyph classes redefining this method)

Returns:

true if the glyph intersects the region delimited by wb, nb, eb, sb

coordInside

public boolean coordInside(int jpx,
                           int jpy,
                           Camera c,
                           double cvx,
                           double cvy)

Description copied from class: Glyph

Detect whether the given point is inside this glyph or not.

Overrides:

coordInside in class VText

Parameters:

jpx - provide projected JPanel coordinates of the associated view, not virtual space coordinates

jpy - provide projected JPanel coordinates of the associated view, not virtual space coordinates

c - camera through which the glyph is observed (only a few types of Glyph actually require this information: SICircle, SIRectangle, VText)

cvx - virtual space coordinates

cvy - virtual space coordinates

See Also:

Glyph.coordInsideV(double cvx, double cvy, Camera c), Glyph.coordInsideP(int jpx, int jpy, Camera c)

coordInsideV

public boolean coordInsideV(double cvx,
                            double cvy,
                            Camera c)

Description copied from class: Glyph

Detect whether the given point is inside this glyph or not. Uses VirtualSpace coordinates.

Overrides:

coordInsideV in class VText

Parameters:

cvx - virtual space coordinates

cvy - virtual space coordinates

c - camera through which the glyph is observed (only a few types of Glyph actually require this information: SICircle, SIRectangle, VText)

See Also:

Glyph.coordInside(int jpx, int jpy, Camera c, double cvx, double cvy), Glyph.coordInsideP(int jpx, int jpy, Camera c)

coordInsideP

public boolean coordInsideP(int jpx,
                            int jpy,
                            Camera c)

Not implemented for VText.

Overrides:

coordInsideP in class VText

Parameters:

jpx - provide projected JPanel coordinates of the associated view, not virtual space coordinates

jpy - provide projected JPanel coordinates of the associated view, not virtual space coordinates

c - camera through which the glyph is observed

See Also:

Glyph.coordInsideV(double cvx, double cvy, Camera c), Glyph.coordInside(int jpx, int jpy, Camera c, double cvx, double cvy)

visibleInDisc

public boolean visibleInDisc(double dvx,
                             double dvy,
                             double dvr,
                             Shape dvs,
                             int camIndex,
                             int jpx,
                             int jpy,
                             int dpr)

Description copied from class: Glyph

Find out if a glyph is visible in a circular area. Not implemented yet for most glyph classes. Used for instance to implement DynaSpot picking.

Overrides:

visibleInDisc in class VText

project

public void project(Camera c,
                    Dimension d)

Description copied from class: Glyph

Project glyph w.r.t a given camera's coordinate system, prior to actual painting. Called internally.

Overrides:

project in class VText

Parameters:

c - camera

d - dimension of View using camera c

projectForLens

public void projectForLens(Camera c,
                           int lensWidth,
                           int lensHeight,
                           float lensMag,
                           double lensx,
                           double lensy)

Description copied from class: Glyph

Project glyph w.r.t a given camera's coordinate system, prior to actual painting through a lens. Called internally.

Overrides:

projectForLens in class VText

Parameters:

c - camera

lensWidth - width of lens activated in View using this camera

lensHeight - height of lens activated in View using this camera

lensMag - magnification factor of lens activated in View using this camera

lensx - horizontal coordinateof lens activated in View using this camera

lensy - vertical coordinate of lens activated in View using this camera

draw

public void draw(Graphics2D g,
                 int vW,
                 int vH,
                 int i,
                 Stroke stdS,
                 AffineTransform stdT,
                 int dx,
                 int dy)

Description copied from class: Glyph

Draw this glyph.

Overrides:

draw in class VText

Parameters:

g - graphics context in which the glyph should be drawn

vW - associated View width (used by some closed shapes to determine if it is worth painting the glyph's border)

vH - associated View height (used by some closed shapes to determine if it is worth painting the glyph's border)

i - camera index in the virtual space containing the glyph

stdS - default stroke

stdT - identity transform

dx - horizontal offset

dy - vertical offset

drawForLens

public void drawForLens(Graphics2D g,
                        int vW,
                        int vH,
                        int i,
                        Stroke stdS,
                        AffineTransform stdT,
                        int dx,
                        int dy)

Description copied from class: Glyph

Draw this glyph through a lens.

Overrides:

drawForLens in class VText

Parameters:

g - graphics context in which the glyph should be drawn

vW - associated View width (used by some closed shapes to determine if it is worth painting the glyph's border)

vH - associated View height (used by some closed shapes to determine if it is worth painting the glyph's border)

i - camera index in the virtual space containing the glyph

stdS - default stroke

stdT - identity transform

dx - horizontal offset

dy - vertical offset

getBounds

public Point2D.Double getBounds(int i)

Get the width and height of the bounding box in virtual space.

Overrides:

getBounds in class VText

Parameters:

i - index of camera (Camera.getIndex())

Returns:

the width and height of the text's bounding box, as a LongPoint

See Also:

VText.validBounds(int i), invalidate()

setFont

public void setFont(Font f)

Change the Font used to display this specific text object.

Overrides:

setFont in class VText

Parameters:

f - set to null to use the default font

See Also:

VText.usesSpecificFont(), VText.getFont()

getJava2DShape

public Shape getJava2DShape()

Description copied from class: Glyph

Get the Java2D Shape corresponding to this Glyph. Virtual Space coordinates.

Overrides:

getJava2DShape in class VText

clone

public Object clone()

Overrides:

clone in class VText

editEvent

public static void editEvent(VTextLayout tl,
                             KeyEvent e)

Default implementation of common edit key events. Supports letters, digits, backspace, delete, non-keypad arrows