/* | |
* ==================================================================== | |
* Licensed to the Apache Software Foundation (ASF) under one or more | |
* contributor license agreements. See the NOTICE file distributed with | |
* this work for additional information regarding copyright ownership. | |
* The ASF licenses this file to You under the Apache License, Version 2.0 | |
* (the "License"); you may not use this file except in compliance with | |
* the License. You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, software | |
* distributed under the License is distributed on an "AS IS" BASIS, | |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
* See the License for the specific language governing permissions and | |
* limitations under the License. | |
* ==================================================================== | |
*/ | |
package org.apache.poi.xslf.usermodel; | |
import java.awt.Insets; | |
import java.net.URI; | |
import javax.xml.namespace.QName; | |
import org.apache.poi.POIXMLException; | |
import org.apache.poi.openxml4j.opc.PackagePart; | |
import org.apache.poi.openxml4j.opc.PackageRelationship; | |
import org.apache.poi.sl.usermodel.PictureShape; | |
import org.apache.poi.sl.usermodel.Placeholder; | |
import org.apache.poi.util.Beta; | |
import org.apache.xmlbeans.XmlCursor; | |
import org.apache.xmlbeans.XmlException; | |
import org.apache.xmlbeans.XmlObject; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTBlip; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTOfficeArtExtension; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTOfficeArtExtensionList; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTPresetGeometry2D; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTRelativeRect; | |
import org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties; | |
import org.openxmlformats.schemas.drawingml.x2006.main.STShapeType; | |
import org.openxmlformats.schemas.presentationml.x2006.main.CTApplicationNonVisualDrawingProps; | |
import org.openxmlformats.schemas.presentationml.x2006.main.CTPicture; | |
import org.openxmlformats.schemas.presentationml.x2006.main.CTPictureNonVisual; | |
/** | |
* Represents a picture shape | |
*/ | |
@Beta | |
public class XSLFPictureShape extends XSLFSimpleShape | |
implements PictureShape<XSLFShape,XSLFTextParagraph> { | |
private XSLFPictureData _data; | |
/*package*/ XSLFPictureShape(CTPicture shape, XSLFSheet sheet) { | |
super(shape, sheet); | |
} | |
/** | |
* @param shapeId 1-based shapeId | |
* @param rel relationship to the picture data in the ooxml package | |
*/ | |
static CTPicture prototype(int shapeId, String rel) { | |
CTPicture ct = CTPicture.Factory.newInstance(); | |
CTPictureNonVisual nvSpPr = ct.addNewNvPicPr(); | |
CTNonVisualDrawingProps cnv = nvSpPr.addNewCNvPr(); | |
cnv.setName("Picture " + shapeId); | |
cnv.setId(shapeId + 1); | |
nvSpPr.addNewCNvPicPr().addNewPicLocks().setNoChangeAspect(true); | |
nvSpPr.addNewNvPr(); | |
CTBlipFillProperties blipFill = ct.addNewBlipFill(); | |
CTBlip blip = blipFill.addNewBlip(); | |
blip.setEmbed(rel); | |
blipFill.addNewStretch().addNewFillRect(); | |
CTShapeProperties spPr = ct.addNewSpPr(); | |
CTPresetGeometry2D prst = spPr.addNewPrstGeom(); | |
prst.setPrst(STShapeType.RECT); | |
prst.addNewAvLst(); | |
return ct; | |
} | |
/** | |
* Is this an internal picture (image data included within | |
* the PowerPoint file), or an external linked picture | |
* (image lives outside)? | |
*/ | |
public boolean isExternalLinkedPicture() { | |
if (getBlipId() == null && getBlipLink() != null) { | |
return true; | |
} | |
return false; | |
} | |
/** | |
* Return the data on the (internal) picture. | |
* For an external linked picture, will return null | |
*/ | |
public XSLFPictureData getPictureData() { | |
if(_data == null){ | |
String blipId = getBlipId(); | |
if (blipId == null) return null; | |
PackagePart p = getSheet().getPackagePart(); | |
PackageRelationship rel = p.getRelationship(blipId); | |
if (rel != null) { | |
try { | |
PackagePart imgPart = p.getRelatedPart(rel); | |
_data = new XSLFPictureData(imgPart); | |
} | |
catch (Exception e) { | |
throw new POIXMLException(e); | |
} | |
} | |
} | |
return _data; | |
} | |
@Override | |
public void setPlaceholder(Placeholder placeholder) { | |
super.setPlaceholder(placeholder); | |
} | |
/** | |
* For an external linked picture, return the last-seen | |
* path to the picture. | |
* For an internal picture, returns null. | |
*/ | |
public URI getPictureLink() { | |
if (getBlipId() != null) { | |
// Internal picture, nothing to return | |
return null; | |
} | |
String rId = getBlipLink(); | |
if (rId == null) { | |
// No link recorded, nothing we can do | |
return null; | |
} | |
PackagePart p = getSheet().getPackagePart(); | |
PackageRelationship rel = p.getRelationship(rId); | |
if (rel != null) { | |
return rel.getTargetURI(); | |
} | |
return null; | |
} | |
protected CTBlipFillProperties getBlipFill() { | |
CTPicture ct = (CTPicture)getXmlObject(); | |
CTBlipFillProperties bfp = ct.getBlipFill(); | |
if (bfp != null) { | |
return bfp; | |
} | |
String xquery = | |
"declare namespace p='http://schemas.openxmlformats.org/presentationml/2006/main'; " | |
+ "declare namespace mc='http://schemas.openxmlformats.org/markup-compatibility/2006' " | |
+ ".//mc:Fallback/p:blipFill" | |
; | |
XmlObject xo = selectProperty(XmlObject.class, xquery); | |
try { | |
xo = CTPicture.Factory.parse(xo.getDomNode()); | |
} catch (XmlException xe) { | |
return null; | |
} | |
return ((CTPicture)xo).getBlipFill(); | |
} | |
protected CTBlip getBlip(){ | |
return getBlipFill().getBlip(); | |
} | |
protected String getBlipLink(){ | |
String link = getBlip().getLink(); | |
if (link.isEmpty()) return null; | |
return link; | |
} | |
protected String getBlipId(){ | |
String id = getBlip().getEmbed(); | |
if (id.isEmpty()) return null; | |
return id; | |
} | |
@Override | |
public Insets getClipping(){ | |
CTRelativeRect r = getBlipFill().getSrcRect(); | |
return (r == null) ? null : new Insets(r.getT(), r.getL(), r.getB(), r.getR()); | |
} | |
@Override | |
void copy(XSLFShape sh){ | |
super.copy(sh); | |
XSLFPictureShape p = (XSLFPictureShape)sh; | |
String blipId = p.getBlipId(); | |
String relId = getSheet().importBlip(blipId, p.getSheet().getPackagePart()); | |
CTPicture ct = (CTPicture)getXmlObject(); | |
CTBlip blip = getBlipFill().getBlip(); | |
blip.setEmbed(relId); | |
CTApplicationNonVisualDrawingProps nvPr = ct.getNvPicPr().getNvPr(); | |
if(nvPr.isSetCustDataLst()) { | |
// discard any custom tags associated with the picture being copied | |
nvPr.unsetCustDataLst(); | |
} | |
if(blip.isSetExtLst()) { | |
CTOfficeArtExtensionList extLst = blip.getExtLst(); | |
for(CTOfficeArtExtension ext : extLst.getExtArray()){ | |
String xpath = "declare namespace a14='http://schemas.microsoft.com/office/drawing/2010/main' $this//a14:imgProps/a14:imgLayer"; | |
XmlObject[] obj = ext.selectPath(xpath); | |
if(obj != null && obj.length == 1){ | |
XmlCursor c = obj[0].newCursor(); | |
String id = c.getAttributeText(new QName("http://schemas.openxmlformats.org/officeDocument/2006/relationships", "embed"));//selectPath("declare namespace r='http://schemas.openxmlformats.org/officeDocument/2006/relationships' $this//[@embed]"); | |
String newId = getSheet().importBlip(id, p.getSheet().getPackagePart()); | |
c.setAttributeText(new QName("http://schemas.openxmlformats.org/officeDocument/2006/relationships", "embed"), newId); | |
c.dispose(); | |
} | |
} | |
} | |
} | |
} |