fr.inria.zvtm.glyphs

Class MultilineText<T>

java.lang.Object

fr.inria.zvtm.glyphs.Glyph

fr.inria.zvtm.glyphs.ClosedShape

fr.inria.zvtm.glyphs.VText

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

All Implemented Interfaces:

Translucent, Cloneable

public class MultilineText<T>
extends VText

Multiline text. By default, text will be rendered on one line. Specifiy a width constraint to make the text overflow on multiple lines. Specify a height constraint to truncate the text. A height constraint is only meaningful if a width constraint has been defined. The 'hot spot' of a MultilineText instance is its top-left corner. This is unlike VText. Note: setting a background color is unsupported.

Field Summary

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
MultilineText(double x, double y, int z, Color c, String t, short ta, float scale, float alpha)
MultilineText(String text)

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.
double	getHeightConstraint()
int	getLineCount() Get number of lines in this MultilineText.
double	getWidthConstraint() Gets the width constraint for this MultilineText.
void	setFont(Font f) Change the Font used to display this specific text object.
void	setHeightConstraint(double constraint) Height constraint, in virtual space units.
void	setText(String text) Set text that should be painted.
void	setWidthConstraint(double constraint) Width constraint, in virtual space units.
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, getBounds, getFont, getJava2DShape, getMainFont, getOrient, getPadding, getScale, getSize, getText, getTextAnchor, getTextDisplayedAsSegCoef, highlight, initCams, invalidate, isScaleIndependent, orientTo, project, projectForLens, removeCamera, reSize, setBorderColor, setMainFont, setPadding, setScale, setScaleIndependent, setTextAnchor, setTextDisplayedAsSegCoef, sizeTo, usesSpecificFont, validBounds, visibleInDisc

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

Constructor Detail

MultilineText

public MultilineText(String text)

MultilineText

public MultilineText(double x,
                     double y,
                     int z,
                     Color c,
                     String t,
                     short ta,
                     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_*)

scale - scaleFactor w.r.t original image size

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

Method Detail

setWidthConstraint

public void setWidthConstraint(double constraint)

Width constraint, in virtual space units.

setHeightConstraint

public void setHeightConstraint(double constraint)

Height constraint, in virtual space units. Text will be truncated if it overflows the height constraint.

getWidthConstraint

public double getWidthConstraint()

Gets the width constraint for this MultilineText. A value of Double.POSITIVE_INFINITY means that the width is unconstrained.

getHeightConstraint

public double getHeightConstraint()

setText

public void setText(String text)

Description copied from class: VText

Set text that should be painted.

Overrides:

setText in class VText

setFont

public void setFont(Font f)

Description copied from class: VText

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

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)

Description copied from class: VText

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)

getLineCount

public int getLineCount()

Get number of lines in this MultilineText. This may vary depending on constraintWidth's value.

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

clone

public Object clone()

Overrides:

clone in class VText