|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfExternalGraphic
public class RtfExternalGraphic
Creates an RTF image from an external graphic file.
This class belongs to the
Supports relative path like "../test.gif", too (01-08-24)
Limitations:
Known Bugs:
This work was authored by Andreas Putz (a.putz@skynamics.com) and Gianugo Rabellino (gianugo@rabellino.it).
Nested Class Summary | |
---|---|
static class |
RtfExternalGraphic.ExternalGraphicException
Exception thrown when an image file/URL cannot be read |
Field Summary | |
---|---|
protected int |
graphicCompressionRate
Graphic compression rate |
protected int |
height
The height of the image (in pixels) |
protected int |
heightDesired
The desired height (in twips) |
protected boolean |
perCentH
Flag whether the desired height is a percentage |
protected boolean |
perCentW
Flag whether the desired width is a percentage |
protected boolean |
scaleUniform
Flag whether the image size shall be adjusted |
protected java.net.URL |
url
The url of the image |
protected int |
width
The width of the image (in pixels) |
protected int |
widthDesired
The desired width (in twips) |
Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement |
---|
attrib, parent, writer |
Constructor Summary | |
---|---|
RtfExternalGraphic(RtfContainer container,
java.io.Writer writer)
Default constructor. |
|
RtfExternalGraphic(RtfContainer container,
java.io.Writer writer,
RtfAttributes attributes)
Default constructor. |
Method Summary | |
---|---|
int |
getCompressionRate()
Gets the compression rate for the image in percent. |
boolean |
isEmpty()
|
boolean |
setCompressionRate(int percent)
Sets the compression rate for the image in percent. |
void |
setCropping(int left,
int top,
int right,
int bottom)
Sets cropping values for all four edges for the \piccrop*N commands. |
void |
setHeight(java.lang.String theHeight)
Sets the desired height of the image. |
void |
setHeightTwips(int twips)
Sets the desired height of the image. |
void |
setImageData(byte[] data)
Sets the binary imagedata of the image. |
void |
setScaling(java.lang.String value)
Sets the flag whether the image size shall be adjusted. |
void |
setUniformScaling(boolean uniform)
Sets the flag whether the image size shall be adjusted. |
void |
setURL(java.lang.String urlString)
Sets the url of the image. |
void |
setWidth(java.lang.String theWidth)
Sets the desired width of the image. |
void |
setWidthTwips(int twips)
Sets the desired width of the image. |
protected void |
writeRtfContent()
RtfElement override - catches ExternalGraphicException and writes a warning message to the document if image cannot be read |
protected void |
writeRtfContentWithException()
Writes the RTF content to m_writer - this one throws ExternalGraphicExceptions |
Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement |
---|
close, getParentOfClass, getRtfAttributes, newLine, okToWriteRtf, toString, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.net.URL url
protected int height
protected int heightDesired
protected boolean perCentH
protected int width
protected int widthDesired
protected boolean perCentW
protected boolean scaleUniform
protected int graphicCompressionRate
Constructor Detail |
---|
public RtfExternalGraphic(RtfContainer container, java.io.Writer writer) throws java.io.IOException
container
- a RtfContainer
valuewriter
- a Writer
value
java.io.IOException
- for I/O problemspublic RtfExternalGraphic(RtfContainer container, java.io.Writer writer, RtfAttributes attributes) throws java.io.IOException
container
- a RtfContainer
valuewriter
- a Writer
valueattributes
- a RtfAttributes
value
java.io.IOException
- for I/O problemsMethod Detail |
---|
protected void writeRtfContent() throws java.io.IOException
writeRtfContent
in class RtfElement
java.io.IOException
- for I/O problemsprotected void writeRtfContentWithException() throws java.io.IOException
java.io.IOException
- On errorpublic void setHeight(java.lang.String theHeight)
theHeight
- The desired image height (as a string in twips or as a percentage)public void setWidth(java.lang.String theWidth)
theWidth
- The desired image width (as a string in twips or as a percentage)public void setWidthTwips(int twips)
twips
- The desired image width (in twips)public void setHeightTwips(int twips)
twips
- The desired image height (in twips)public void setScaling(java.lang.String value)
value
- true image width or height shall be adjusted automatically\n
false no adjustmentpublic void setUniformScaling(boolean uniform)
uniform
- true image width or height shall be adjusted automatically\n
false no adjustmentpublic void setCropping(int left, int top, int right, int bottom)
left
- left cropping value (in twips)top
- top cropping value (in twips)right
- right cropping value (in twips)bottom
- bottom cropping value (in twips)public void setImageData(byte[] data) throws java.io.IOException
data
- binary imagedata as read from file.
java.io.IOException
- On errorpublic void setURL(java.lang.String urlString) throws java.io.IOException
urlString
- Image url like "file://..."
java.io.IOException
- On errorpublic int getCompressionRate()
public boolean setCompressionRate(int percent)
percent
- Compression rate
public boolean isEmpty()
isEmpty
in class RtfElement
|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |