com.tutego.jrtf

Class RtfPicture

java.lang.Object

com.tutego.jrtf.RtfPicture

public class RtfPicture
extends Object

Represents an image which can be added to an RTF document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RtfPicture.PictureType The image type of the picture.

Method Summary

Methods

Modifier and Type	Method and Description
RtfPicture	height(double height, RtfUnit unit) Height of the image.
RtfPicture	scale(int scaleX, int scaleY) Scale the image.
RtfPicture	scaleX(int scale) Horizontal scaling.
RtfPicture	scaleY(int scale) Vertical scaling.
RtfPicture	size(double width, double height, RtfUnit unit) Size of the picture.
RtfText	type(RtfPicture.PictureType pictureType) Sets the type and finish setting a picture.
RtfPicture	width(double width, RtfUnit unit) Width of the image.

Methods inherited from class java.lang.Object

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

Method Detail

width

public RtfPicture width(double width,
               RtfUnit unit)

Width of the image.

Parameters:

width - Width of the image.

unit - Measurement.

Returns:

this-object.

height

public RtfPicture height(double height,
                RtfUnit unit)

Height of the image.

Parameters:

height - Height of the image.

unit - Measurement.

Returns:

this-object.

size

public RtfPicture size(double width,
              double height,
              RtfUnit unit)

Size of the picture.

Parameters:

width - Width of the image.

height - Height of the image.

unit - Measurement.

Returns:

this-object.

scaleX

public RtfPicture scaleX(int scale)

Horizontal scaling. Default is 100.

Parameters:

scale - Scale.

Returns:

this-object.

scaleY

public RtfPicture scaleY(int scale)

Vertical scaling. Default is 100.

Parameters:

scale - Scale.

Returns:

this-object.

scale

public RtfPicture scale(int scaleX,
               int scaleY)

Scale the image.

Parameters:

scaleX - Scale for X.

scaleY - Scale for Y.

Returns:

this-object.

type

public RtfText type(RtfPicture.PictureType pictureType)

Sets the type and finish setting a picture.

Parameters:

pictureType - Type of this picture. Usually RtfPicture.PictureType.AUTOMATIC is a good choise.

Returns:

RtfText.