Return-Path: X-Original-To: apmail-poi-commits-archive@minotaur.apache.org Delivered-To: apmail-poi-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 50C46D575 for ; Thu, 20 Dec 2012 13:22:47 +0000 (UTC) Received: (qmail 79296 invoked by uid 500); 20 Dec 2012 13:22:47 -0000 Delivered-To: apmail-poi-commits-archive@poi.apache.org Received: (qmail 79207 invoked by uid 500); 20 Dec 2012 13:22:47 -0000 Mailing-List: contact commits-help@poi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@poi.apache.org Delivered-To: mailing list commits@poi.apache.org Received: (qmail 79038 invoked by uid 99); 20 Dec 2012 13:22:46 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Dec 2012 13:22:46 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Dec 2012 13:22:39 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id A897C2388BEC; Thu, 20 Dec 2012 13:21:14 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1424453 [23/41] - in /poi/site/publish/apidocs/org/apache/poi/xslf: ./ class-use/ extractor/ extractor/class-use/ model/ model/class-use/ model/geom/ model/geom/class-use/ usermodel/ usermodel/class-use/ util/ util/class-use/ Date: Thu, 20 Dec 2012 13:21:02 -0000 To: commits@poi.apache.org From: yegor@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121220132114.A897C2388BEC@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureData.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureData.html?rev=1424453&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureData.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureData.html Thu Dec 20 13:20:57 2012 @@ -0,0 +1,646 @@ + + + + + + +XSLFPictureData (POI API Documentation) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.poi.xslf.usermodel +
+Class XSLFPictureData

+
+java.lang.Object
+  extended by org.apache.poi.POIXMLDocumentPart
+      extended by org.apache.poi.xslf.usermodel.XSLFPictureData
+
+
+
+
@Beta
+public final class XSLFPictureData
extends POIXMLDocumentPart
+ + +

+Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type +

+ +

+

+
Author:
+
Yegor Kozlov
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intPICTURE_TYPE_BMP + +
+          Windows Bitmap (.bmp)
+static intPICTURE_TYPE_DIB + +
+          Device independent bitmap
+static intPICTURE_TYPE_EMF + +
+          Extended windows meta file
+static intPICTURE_TYPE_EPS + +
+          Encapsulated Postscript (.eps)
+static intPICTURE_TYPE_GIF + +
+          GIF image format
+static intPICTURE_TYPE_JPEG + +
+          JPEG format
+static intPICTURE_TYPE_PICT + +
+          Mac PICT format
+static intPICTURE_TYPE_PNG + +
+          PNG format
+static intPICTURE_TYPE_TIFF + +
+          Tag Image File (.tiff)
+static intPICTURE_TYPE_WMF + +
+          Windows Meta File
+static intPICTURE_TYPE_WPG + +
+          WordPerfect graphics (.wpg)
+protected static POIXMLRelation[]RELATIONS + +
+          Relationships for each known picture type
+ + + + + + + +
Fields inherited from class org.apache.poi.POIXMLDocumentPart
DEFAULT_XML_OPTIONS
+  + + + + + + + + + + + + + + + +
+Constructor Summary
+protected XSLFPictureData() + +
+          Create a new XSLFGraphicData node
+ XSLFPictureData(PackagePart part, + PackageRelationship rel) + +
+          Construct XSLFPictureData from a package part
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]getData() + +
+          Gets the picture data as a byte array.
+ java.lang.StringgetFileName() + +
+          Returns the file name of the image, eg image7.jpg .
+ intgetPictureType() + +
+          Return an integer constant that specifies type of this picture
+ java.lang.StringsuggestFileExtension() + +
+          Suggests a file extension for this image.
+ + + + + + + +
Methods inherited from class org.apache.poi.POIXMLDocumentPart
addRelation, commit, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, < A HREF="../../../../../org/apache/poi/POIXMLDocumentPart.html#read(org.apache.poi.POIXMLFactory, java.util.Map)">read, rebase, removeRelation, removeRelation, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+PICTURE_TYPE_EMF

+
+public static final int PICTURE_TYPE_EMF
+
+
Extended windows meta file +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_WMF

+
+public static final int PICTURE_TYPE_WMF
+
+
Windows Meta File +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_PICT

+
+public static final int PICTURE_TYPE_PICT
+
+
Mac PICT format +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_JPEG

+
+public static final int PICTURE_TYPE_JPEG
+
+
JPEG format +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_PNG

+
+public static final int PICTURE_TYPE_PNG
+
+
PNG format +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_DIB

+
+public static final int PICTURE_TYPE_DIB
+
+
Device independent bitmap +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_GIF

+
+public static final int PICTURE_TYPE_GIF
+
+
GIF image format +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_TIFF

+
+public static final int PICTURE_TYPE_TIFF
+
+
Tag Image File (.tiff) +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_EPS

+
+public static final int PICTURE_TYPE_EPS
+
+
Encapsulated Postscript (.eps) +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_BMP

+
+public static final int PICTURE_TYPE_BMP
+
+
Windows Bitmap (.bmp) +

+

+
See Also:
Constant Field Values
+
+
+ +

+PICTURE_TYPE_WPG

+
+public static final int PICTURE_TYPE_WPG
+
+
WordPerfect graphics (.wpg) +

+

+
See Also:
Constant Field Values
+
+
+ +

+RELATIONS

+
+protected static final POIXMLRelation[] RELATIONS
+
+
Relationships for each known picture type +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+XSLFPictureData

+
+protected XSLFPictureData()
+
+
Create a new XSLFGraphicData node +

+

+
+ +

+XSLFPictureData

+
+public XSLFPictureData(PackagePart part,
+                       PackageRelationship rel)
+
+
Construct XSLFPictureData from a package part +

+

+
Parameters:
part - the package part holding the drawing data,
rel - the package relationship holding this drawing, + the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+
+ + + + + + + + +
+Method Detail
+ +

+getData

+
+public byte[] getData()
+
+
Gets the picture data as a byte array. +

+ Note, that this call might be expensive since all the picture data is copied into a temporary byte array. + You can grab the picture data directly from the underlying package part as follows: +
+ + InputStream is = getPackagePart().getInputStream(); + +

+

+

+ +
Returns:
the Picture data.
+
+
+
+ +

+getFileName

+
+public java.lang.String getFileName()
+
+
Returns the file name of the image, eg image7.jpg . The original filename + isn't always available, but if it can be found it's likely to be in the + CTDrawing +

+

+
+
+
+
+ +

+suggestFileExtension

+
+public java.lang.String suggestFileExtension()
+
+
Suggests a file extension for this image. +

+

+ +
Returns:
the file extension.
+
+
+
+ +

+getPictureType

+
+public int getPictureType()
+
+
Return an integer constant that specifies type of this picture +

+

+ +
Returns:
an integer constant that specifies type of this picture
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2012 The Apache Software Foundation or + its licensors, as applicable. + + + Propchange: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureData.html ------------------------------------------------------------------------------ svn:executable = * Added: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureShape.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureShape.html?rev=1424453&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureShape.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureShape.html Thu Dec 20 13:20:57 2012 @@ -0,0 +1,299 @@ + + + + + + +XSLFPictureShape (POI API Documentation) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.poi.xslf.usermodel +
+Class XSLFPictureShape

+
+java.lang.Object
+  extended by org.apache.poi.xslf.usermodel.XSLFShape
+      extended by org.apache.poi.xslf.usermodel.XSLFSimpleShape
+          extended by org.apache.poi.xslf.usermodel.XSLFPictureShape
+
+
+
+
@Beta
+public class XSLFPictureShape
extends XSLFSimpleShape
+ + +

+Represents a picture shape +

+ +

+

+
Author:
+
Yegor Kozlov
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddrawContent(java.awt.Graphics2D graphics) + +
+          draw any content within this shape (image, text, etc.).
+ XSLFPictureDatagetPictureData() + +
+           
+ voidresize() + +
+          Resize this picture to the default size.
+ + + + + + + +
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSimpleShape
draw, getAnchor, getCTPlaceholder, getFillColor, getFlipHorizontal, getFlipVertical, getLineCap, getLineColor, getLineDash, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getNvPr, getRotation, getShadow, getShapeId, getShapeName, getShapeType, getSheet, getSpPr, getSpStyle, getXmlObject, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineDash, setLineHeadDecor ation, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType
+ + + + + + + +
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
applyTransform
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+resize

+
+public void resize()
+
+
Resize this picture to the default size. + For PNG and JPEG resizes the image to 100%, + for other types sets the default size of 200x200 pixels. +

+

+
+
+
+
+ +

+getPictureData

+
+public XSLFPictureData getPictureData()
+
+
+
+
+
+
+ +

+drawContent

+
+public void drawContent(java.awt.Graphics2D graphics)
+
+
Description copied from class: XSLFSimpleShape
+
draw any content within this shape (image, text, etc.). +

+

+
Overrides:
drawContent in class XSLFSimpleShape
+
+
+
Parameters:
graphics - the graphics to draw into
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2012 The Apache Software Foundation or + its licensors, as applicable. + + + Propchange: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFPictureShape.html ------------------------------------------------------------------------------ svn:executable = * Added: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFRelation.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFRelation.html?rev=1424453&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFRelation.html (added) +++ poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFRelation.html Thu Dec 20 13:20:57 2012 @@ -0,0 +1,842 @@ + + + + + + +XSLFRelation (POI API Documentation) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.poi.xslf.usermodel +
+Class XSLFRelation

+
+java.lang.Object
+  extended by org.apache.poi.POIXMLRelation
+      extended by org.apache.poi.xslf.usermodel.XSLFRelation
+
+
+
+
@Beta
+public class XSLFRelation
extends POIXMLRelation
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected static java.util.Map<java.lang.String,XSLFRelation>_table + +
+          A map to lookup POIXMLRelation by its relation type
+static XSLFRelationCHART + +
+           
+static XSLFRelationCOMMENT_AUTHORS + +
+           
+static XSLFRelationCOMMENTS + +
+           
+static XSLFRelationHYPERLINK + +
+           
+static XSLFRelationIMAGE_BMP + +
+           
+static XSLFRelationIMAGE_DIB + +
+           
+static XSLFRelationIMAGE_EMF + +
+           
+static XSLFRelationIMAGE_EPS + +
+           
+static XSLFRelationIMAGE_GIF + +
+           
+static XSLFRelationIMAGE_JPEG + +
+           
+static XSLFRelationIMAGE_PICT + +
+           
+static XSLFRelationIMAGE_PNG + +
+           
+static XSLFRelationIMAGE_TIFF + +
+           
+static XSLFRelationIMAGE_WMF + +
+           
+static XSLFRelationIMAGE_WPG + +
+           
+static XSLFRelationIMAGES + +
+           
+static XSLFRelationMACRO + +
+           
+static XSLFRelationMACRO_TEMPLATE + +
+           
+static XSLFRelationMAIN + +
+           
+static XSLFRelationNOTES + +
+           
+static XSLFRelationNOTES_MASTER + +
+           
+static XSLFRelationPRESENTATION_MACRO + +
+           
+static XSLFRelationPRESENTATIONML + +
+           
+static XSLFRelationPRESENTATIONML_TEMPLATE + +
+           
+static XSLFRelationSLIDE + +
+           
+static XSLFRelationSLIDE_LAYOUT + +
+           
+static XSLFRelationSLIDE_MASTER + +
+           
+static XSLFRelationTABLE_STYLES + +
+           
+static XSLFRelationTHEME + +
+           
+static XSLFRelationTHEME_MANAGER + +
+           
+static XSLFRelationVML_DRAWING + +
+           
+ + + + + + + +
Fields inherited from class org.apache.poi.POIXMLRelation
_defaultName, _relation, _type
+  + + + + + + + + + + + +
+Method Summary
+static XSLFRelationgetInstance(java.lang.String rel) + +
+          Get POIXMLRelation by relation type
+ + + + + + + +
Methods inherited from class org.apache.poi.POIXMLRelation
getContentType, getDefaultFileName, getFileName, getRelation, getRelationClass
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_table

+
+protected static java.util.Map<java.lang.String,XSLFRelation> _table
+
+
A map to lookup POIXMLRelation by its relation type +

+

+
+
+
+ +

+MAIN

+
+public static final XSLFRelation MAIN
+
+
+
+
+
+ +

+MACRO

+
+public static final XSLFRelation MACRO
+
+
+
+
+
+ +

+MACRO_TEMPLATE

+
+public static final XSLFRelation MACRO_TEMPLATE
+
+
+
+
+
+ +

+PRESENTATIONML

+
+public static final XSLFRelation PRESENTATIONML
+
+
+
+
+
+ +

+PRESENTATIONML_TEMPLATE

+
+public static final XSLFRelation PRESENTATIONML_TEMPLATE
+
+
+
+
+
+ +

+PRESENTATION_MACRO

+
+public static final XSLFRelation PRESENTATION_MACRO
+
+
+
+
+
+ +

+THEME_MANAGER

+
+public static final XSLFRelation THEME_MANAGER
+
+
+
+
+
+ +

+NOTES

+
+public static final XSLFRelation NOTES
+
+
+
+
+
+ +

+SLIDE

+
+public static final XSLFRelation SLIDE
+
+
+
+
+
+ +

+SLIDE_LAYOUT

+
+public static final XSLFRelation SLIDE_LAYOUT
+
+
+
+
+
+ +

+SLIDE_MASTER

+
+public static final XSLFRelation SLIDE_MASTER
+
+
+
+
+
+ +

+NOTES_MASTER

+
+public static final XSLFRelation NOTES_MASTER
+
+
+
+
+
+ +

+COMMENTS

+
+public static final XSLFRelation COMMENTS
+
+
+
+
+
+ +

+COMMENT_AUTHORS

+
+public static final XSLFRelation COMMENT_AUTHORS
+
+
+
+
+
+ +

+HYPERLINK

+
+public static final XSLFRelation HYPERLINK
+
+
+
+
+
+ +

+THEME

+
+public static final XSLFRelation THEME
+
+
+
+
+
+ +

+VML_DRAWING

+
+public static final XSLFRelation VML_DRAWING
+
+
+
+
+
+ +

+CHART

+
+public static final XSLFRelation CHART
+
+
+
+
+
+ +

+IMAGE_EMF

+
+public static final XSLFRelation IMAGE_EMF
+
+
+
+
+
+ +

+IMAGE_WMF

+
+public static final XSLFRelation IMAGE_WMF
+
+
+
+
+
+ +

+IMAGE_PICT

+
+public static final XSLFRelation IMAGE_PICT
+
+
+
+
+
+ +

+IMAGE_JPEG

+
+public static final XSLFRelation IMAGE_JPEG
+
+
+
+
+
+ +

+IMAGE_PNG

+
+public static final XSLFRelation IMAGE_PNG
+
+
+
+
+
+ +

+IMAGE_DIB

+
+public static final XSLFRelation IMAGE_DIB
+
+
+
+
+
+ +

+IMAGE_GIF

+
+public static final XSLFRelation IMAGE_GIF
+
+
+
+
+
+ +

+IMAGE_TIFF

+
+public static final XSLFRelation IMAGE_TIFF
+
+
+
+
+
+ +

+IMAGE_EPS

+
+public static final XSLFRelation IMAGE_EPS
+
+
+
+
+
+ +

+IMAGE_BMP

+
+public static final XSLFRelation IMAGE_BMP
+
+
+
+
+
+ +

+IMAGE_WPG

+
+public static final XSLFRelation IMAGE_WPG
+
+
+
+
+
+ +

+IMAGES

+
+public static final XSLFRelation IMAGES
+
+
+
+
+
+ +

+TABLE_STYLES

+
+public static final XSLFRelation TABLE_STYLES
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+getInstance

+
+public static XSLFRelation getInstance(java.lang.String rel)
+
+
Get POIXMLRelation by relation type +

+

+
Parameters:
rel - relation type, for example, + http://schemas.openxmlformats.org/officeDocument/2006/relationships/image +
Returns:
registered POIXMLRelation or null if not found
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2012 The Apache Software Foundation or + its licensors, as applicable. + + + Propchange: poi/site/publish/apidocs/org/apache/poi/xslf/usermodel/XSLFRelation.html ------------------------------------------------------------------------------ svn:executable = * --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org For additional commands, e-mail: commits-help@poi.apache.org