EmfPlusDrawDriverString

Inheritance: java.lang.Object, com.aspose.imaging.fileformats.emf.MetaObject, com.aspose.imaging.fileformats.emf.emfplus.records.EmfPlusRecord, com.aspose.imaging.fileformats.emf.emfplus.records.EmfPlusDrawingRecordType

public final class EmfPlusDrawDriverString extends EmfPlusDrawingRecordType

The EmfPlusDrawDriverString record specifies text output with character positions.

Constructors

ConstructorDescription
EmfPlusDrawDriverString(EmfPlusRecord source)Initializes a new instance of the EmfPlusDrawDriverString class.

Methods

MethodDescription
getObjectId()Gets the object identifier.
setObjectId(byte value)Sets the object identifier.
getBrushId()Gets the brush identifier A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush, depending on the value of the S flag in the Flags
setBrushId(int value)Sets the brush identifier A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush, depending on the value of the S flag in the Flags
getDriverStringOptionsFlags()Gets the driver string options flags A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.
setDriverStringOptionsFlags(int value)Sets the driver string options flags A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.
getGlyphCount()Gets the glyph count A 32-bit unsigned integer that specifies number of glyphs in the string
setGlyphCount(int value)Sets the glyph count A 32-bit unsigned integer that specifies number of glyphs in the string
getGlyphPos()Gets the glyph positions array An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph.
setGlyphPos(PointF[] value)Sets the glyph positions array An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph.
getGlyphs()Gets the glyphs array An array of 16-bit values that define the text string to draw.
setGlyphs(short[] value)Sets the glyphs array An array of 16-bit values that define the text string to draw.
isColor()Gets or sets a value indicating whether this instance is color.
setColor(boolean value)Sets a value indicating whether this instance is color.
getMatrixPresent()Gets if the matrix present flag A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field 0 - no matrix present.
setMatrixPresent(int value)Sets if the matrix present flag A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field 0 - no matrix present.
getTransformMatrix()Gets the transform matrix An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to each value in the text array.
setTransformMatrix(Matrix value)Sets the transform matrix An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to each value in the text array.

EmfPlusDrawDriverString(EmfPlusRecord source)

public EmfPlusDrawDriverString(EmfPlusRecord source)

Initializes a new instance of the EmfPlusDrawDriverString class.

Parameters:

ParameterTypeDescription
sourceEmfPlusRecordThe source.

getObjectId()

public byte getObjectId()

Gets the object identifier. The EMF+ Object Table index of an `` object (section 2.2.1.3) to render the text. The value MUST be zero to 63, inclusive.

Returns: byte - The object identifier.

setObjectId(byte value)

public void setObjectId(byte value)

Sets the object identifier. The EMF+ Object Table index of an `` object (section 2.2.1.3) to render the text. The value MUST be zero to 63, inclusive.

Parameters:

ParameterTypeDescription
valuebyteThe object identifier.

getBrushId()

public int getBrushId()

Gets the brush identifier A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush, depending on the value of the S flag in the Flags

Returns: int

setBrushId(int value)

public void setBrushId(int value)

Sets the brush identifier A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush, depending on the value of the S flag in the Flags

Parameters:

ParameterTypeDescription
valueint

getDriverStringOptionsFlags()

public int getDriverStringOptionsFlags()

Gets the driver string options flags A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.

Returns: int

setDriverStringOptionsFlags(int value)

public void setDriverStringOptionsFlags(int value)

Sets the driver string options flags A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.

Parameters:

ParameterTypeDescription
valueint

getGlyphCount()

public int getGlyphCount()

Gets the glyph count A 32-bit unsigned integer that specifies number of glyphs in the string

Returns: int

setGlyphCount(int value)

public void setGlyphCount(int value)

Sets the glyph count A 32-bit unsigned integer that specifies number of glyphs in the string

Parameters:

ParameterTypeDescription
valueint

getGlyphPos()

public PointF[] getGlyphPos()

Gets the glyph positions array An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph. There MUST be GlyphCount elements, which have a one-to-one correspondence with the elements in the Glyphs array. Glyph positions are calculated from the position of the first glyph if the DriverStringOptionsRealizedAdvance flag in DriverStringOptions flags is set. In this case, GlyphPos specifies the position of the first glyph only.

Returns: com.aspose.imaging.PointF[]

setGlyphPos(PointF[] value)

public void setGlyphPos(PointF[] value)

Sets the glyph positions array An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph. There MUST be GlyphCount elements, which have a one-to-one correspondence with the elements in the Glyphs array. Glyph positions are calculated from the position of the first glyph if the DriverStringOptionsRealizedAdvance flag in DriverStringOptions flags is set. In this case, GlyphPos specifies the position of the first glyph only.

Parameters:

ParameterTypeDescription
valuePointF[]

getGlyphs()

public short[] getGlyphs()

Gets the glyphs array An array of 16-bit values that define the text string to draw. If the DriverStringOptionsCmapLookup flag in the DriverStringOptionsFlags field is set, each value in this array specifies a Unicode character. Otherwise, each value specifies an index to a character glyph in the EmfPlusFont object specified by the ObjectId value in Flags field.

Returns: short[]

setGlyphs(short[] value)

public void setGlyphs(short[] value)

Sets the glyphs array An array of 16-bit values that define the text string to draw. If the DriverStringOptionsCmapLookup flag in the DriverStringOptionsFlags field is set, each value in this array specifies a Unicode character. Otherwise, each value specifies an index to a character glyph in the EmfPlusFont object specified by the ObjectId value in Flags field.

Parameters:

ParameterTypeDescription
valueshort[]

isColor()

public boolean isColor()

Gets or sets a value indicating whether this instance is color. This bit indicates the type of data in the BrushId field. If set, BrushId specifies the color value in an EmfPlusARGB object (section 2.2.2.1). If clear, BrushId contains the EMF+ Object Table index of an EmfPlusBrush object (section 2.2.1.1).

Returns: boolean - true if this instance is color; otherwise, false.

setColor(boolean value)

public void setColor(boolean value)

Sets a value indicating whether this instance is color. This bit indicates the type of data in the BrushId field. If set, BrushId specifies the color value in an EmfPlusARGB object (section 2.2.2.1). If clear, BrushId contains the EMF+ Object Table index of an EmfPlusBrush object (section 2.2.1.1).

Parameters:

ParameterTypeDescription
valuebooleantrue if this instance is color; otherwise, false.

getMatrixPresent()

public int getMatrixPresent()

Gets if the matrix present flag A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field 0 - no matrix present. 1 - transform matrix is in TransformMatrix field

Returns: int

setMatrixPresent(int value)

public void setMatrixPresent(int value)

Sets if the matrix present flag A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field 0 - no matrix present. 1 - transform matrix is in TransformMatrix field

Parameters:

ParameterTypeDescription
valueint

getTransformMatrix()

public Matrix getTransformMatrix()

Gets the transform matrix An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to each value in the text array. The presence of this data is determined from the MatrixPresent field.

Returns: Matrix

setTransformMatrix(Matrix value)

public void setTransformMatrix(Matrix value)

Sets the transform matrix An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to each value in the text array. The presence of this data is determined from the MatrixPresent field.

Parameters:

ParameterTypeDescription
valueMatrix