Class J2Ci.jDVPSTextObject
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class J2Ci.jDVPSTextObject

Object
   |
   +----J2Ci.jDVPSTextObject

public class jDVPSTextObject
extends Object
A jDVPSTextObject is the Java-sided class for the C++-Class DVPSTextObject.

Author:
Andreas Schröter

Constructor Index

 o J2Ci.jDVPSTextObject()
Constructor - not allowed!
 o J2Ci.jDVPSTextObject(long)
Constructor for attaching an existing C++-Object.
 o J2Ci.jDVPSTextObject(jDVPSTextObject)
Copy-Constructor

Method Index

 o anchorPointIsVisible()
Gets the anchor point visibility May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
 o getAnchorPointAnnotationUnits()
Gets the anchor point annotation units.
 o getAnchorPoint_x()
Gets the anchor point x value.
 o getAnchorPoint_y()
Gets the anchor point y value.
 o getBoundingBoxAnnotationUnits()
Gets the bounding box annotation units.
 o getBoundingBoxBRHC_x()
Gets the bounding box BRHC x value.
 o getBoundingBoxBRHC_y()
Gets the bounding box BRHC y value.
 o getBoundingBoxTLHC_x()
Gets the bounding box TLHC x value.
 o getBoundingBoxTLHC_y()
Gets the bounding box TLHC y value.
 o getCharset(int)
Gets the specific character set for this text object.
 o getCharsetString()
Gets the specific character set string for this text object.
 o getText()
Gets the unformatted text value for this text object.
 o haveAnchorPoint()
Checks if this text object contains an anchor point.
 o haveBoundingBox()
Checks if this text object contains bounding box.
 o removeAnchorPoint()
Removes any anchor point from the text object.
 o removeBoundingBox()
Removes any bounding box from the text object.
 o setAnchorPoint(double, double, int, boolean)
Sets an anchor point for this text object.
 o setBoundingBox(double, double, double, double, int)
Sets bounding box for this text object.
 o setCharset(int, int)
Sets the specific character set for this text object.
 o setText(String)
Assigns a new "unformatted text value" for this text object.

Constructors

 o jDVPSTextObject
protected jDVPSTextObject()
Constructor - not allowed!

 o jDVPSTextObject
public jDVPSTextObject(long attachAdr)
Constructor for attaching an existing C++-Object. FOR INTERNAL USE ONLY!

Parameters:
attachAdr - Address of C++-Object
 o jDVPSTextObject
public jDVPSTextObject(jDVPSTextObject copy)
Copy-Constructor

Parameters:
copy - TextObject-Object to copy

Methods

 o anchorPointIsVisible
public native boolean anchorPointIsVisible()
Gets the anchor point visibility May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)

Returns:
true if anchor point is visible
 o getAnchorPointAnnotationUnits
public native int getAnchorPointAnnotationUnits()
Gets the anchor point annotation units. May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)

Returns:
anchor point annotation units (from jDVPSannotationUnit).
 o getAnchorPoint_x
public native double getAnchorPoint_x()
Gets the anchor point x value. May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)

Returns:
anchor point x value
 o getAnchorPoint_y
public native double getAnchorPoint_y()
Gets the anchor point y value. May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)

Returns:
anchor point y value
 o getBoundingBoxAnnotationUnits
public native int getBoundingBoxAnnotationUnits()
Gets the bounding box annotation units. May only be called when a bounding box is present (haveBoundingBox()==OFTrue)

Returns:
bounding box annotation units (from jDVPSannotationUnit).
 o getBoundingBoxBRHC_x
public native double getBoundingBoxBRHC_x()
Gets the bounding box BRHC x value. May only be called when a bounding box is present (haveBoundingBox()==OFTrue)

Returns:
bounding box BRHC x value
 o getBoundingBoxBRHC_y
public native double getBoundingBoxBRHC_y()
Gets the bounding box BRHC y value. May only be called when a bounding box is present (haveBoundingBox()==OFTrue)

Returns:
bounding box BRHC y value
 o getBoundingBoxTLHC_x
public native double getBoundingBoxTLHC_x()
Gets the bounding box TLHC x value. May only be called when a bounding box is present (haveBoundingBox()==OFTrue)

Returns:
bounding box TLHC x value
 o getBoundingBoxTLHC_y
public native double getBoundingBoxTLHC_y()
Gets the bounding box TLHC y value. May only be called when a bounding box is present (haveBoundingBox()==OFTrue)

Returns:
bounding box TLHC y value
 o getCharset
public native int getCharset(int higherLevelCharset)
Gets the specific character set for this text object.

Parameters:
higherLevelCharset - specific character set of the presentation state object in which this text object is embedded. If this parameter is not passed (i.e. the default value is passed), this method assumes that the presentation state object contains no specific character set(from jDVPScharacterSet).
Returns:
character set identifier (from jDVPScharacterSet).
 o getCharsetString
public native java.lang.String getCharsetString()
Gets the specific character set string for this text object.

Returns:
character set if present, null otherwise
 o getText
public native java.lang.String getText()
Gets the unformatted text value for this text object.

Returns:
unformatted text value
 o haveAnchorPoint
public native boolean haveAnchorPoint()
Checks if this text object contains an anchor point.

Returns:
true if anchor point present.
 o haveBoundingBox
public native boolean haveBoundingBox()
Checks if this text object contains bounding box.

Returns:
true if bounding box present.
 o removeAnchorPoint
public native void removeAnchorPoint()
Removes any anchor point from the text object. Attention: A text object must always contain either anchor point, bounding box or both. This property is not asserted by the text object itself.

 o removeBoundingBox
public native void removeBoundingBox()
Removes any bounding box from the text object. Attention: A text object must always contain either anchor point, bounding box or both. This property is not asserted by the text object itself.

 o setAnchorPoint
public native int setAnchorPoint(double x,
                                 double y,
                                 int unit,
                                 boolean isVisible)
Sets an anchor point for this text object.

Parameters:
x - anchor point X value
y - anchor point Y value
unit - anchor point annotation units (pixel/display) (from jDVPSannotationUnit).
isVisible - anchor point visibility
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setBoundingBox
public native int setBoundingBox(double TLHC_x,
                                 double TLHC_y,
                                 double BRHC_x,
                                 double BRHC_y,
                                 int unit)
Sets bounding box for this text object.

Parameters:
TLHC_x - bounding box top-lefthand corner X value
TLHC_x - bounding box top-lefthand corner Y value
BRHC_x - bounding box bottom-righthand corner X value
BRHC_x - bounding box bottom-righthand corner Y value
unit - bounding box annotation units (pixel/display) (from jDVPSannotationUnit)
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setCharset
public native int setCharset(int charset,
                             int higherLevelCharset)
Sets the specific character set for this text object.

Parameters:
charset - the new character set for this text object (from jDVPScharacterSet).
higherLevelCharset - the specific character set of the presentation state in which the text object is embedded. If this parameter is _not_ passed (i.e. the default value is passed), this method assumes that the main presentation state might contain an unknown character set and always explicitly sets the character set for the text object. If this parameter is passed, it is used to optimize the specific character set definition in the text object (from jDVPScharacterSet).
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setText
public native int setText(String text)
Assigns a new "unformatted text value" for this text object.

Parameters:
text - unformatted text value. Must not be NULL or empty string.
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).

All Packages  Class Hierarchy  This Package  Previous  Next  Index