Class OdfDrawImage
java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.odftoolkit.odfdom.pkg.OdfElement
org.odftoolkit.odfdom.dom.element.draw.DrawImageElement
org.odftoolkit.odfdom.incubator.doc.draw.OdfDrawImage
- All Implemented Interfaces:
Serializable
,Cloneable
,Element
,ElementTraversal
,EventTarget
,Node
,NodeList
,TypeInfo
Convenient functionality for the parent ODF OpenDocument element
- See Also:
-
Field Summary
Fields inherited from class org.odftoolkit.odfdom.dom.element.draw.DrawImageElement
ELEMENT_NAME
Fields inherited from class org.apache.xerces.dom.ElementNSImpl
localName, namespaceURI
Fields inherited from class org.apache.xerces.dom.ElementImpl
attributes, name
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
Fields inherited from class org.apache.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
Fields inherited from interface org.w3c.dom.TypeInfo
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
deleteImage
(OdfSchemaDocument doc, OdfDrawImage image) The method deletes the specified image from image container.static void
deleteImageByPath
(OdfSchemaDocument doc, String imagePath) The method deletes one or more images from image container by image path.static List<OdfDrawImage>
getImageByPath
(OdfSchemaDocument doc, String imagePath) The method returns the specific one or more images by image path since the image may be inserted to the document several times.static int
Get the count of image objects in the image container.The method return the set of all the image paths.static List<OdfDrawImage>
The method return the image list in the image container.Return the URI for this imagevoid
Inserts the image file from the stream to the ODF package named similar as in the provided path..void
newImage
(InputStream is, String packagePath, String mediaType) Inserts the image file from the stream to the ODF package named similar as in the provided path..Inserts the image file from the URI to the ODF package named similar as in the URI.void
setImagePath
(String packagePath) The image path will be stored as URI of the href attributeMethods inherited from class org.odftoolkit.odfdom.dom.element.draw.DrawImageElement
accept, getDrawFilterNameAttribute, getOdfName, getXlinkActuateAttribute, getXlinkHrefAttribute, getXlinkShowAttribute, getXlinkTypeAttribute, getXmlIdAttribute, newOfficeBinaryDataElement, newTextListElement, newTextPElement, setDrawFilterNameAttribute, setXlinkActuateAttribute, setXlinkHrefAttribute, setXlinkShowAttribute, setXlinkTypeAttribute, setXmlIdAttribute
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttribute, setOdfAttributeValue, setRepetition, split, toString
Methods inherited from class org.apache.xerces.dom.ElementNSImpl
getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType
Methods inherited from class org.apache.xerces.dom.ElementImpl
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData
Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, item, setTextContent, synchronizeChildren
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.w3c.dom.Node
compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData
-
Constructor Details
-
OdfDrawImage
Creates a new instance of this class- Parameters:
ownerDoc
- The XML DOM containing the draw:image element
-
-
Method Details
-
getImageUri
Return the URI for this image- Returns:
- the URI of image
-
setImagePath
The image path will be stored as URI of the href attribute- Parameters:
packagePath
- The relative path from the package root to the image
-
newImage
Inserts the image file from the URI to the ODF package named similar as in the URI. The manifest is adapted using the media type according to the suffix. Existing images are replaced. Note: Default image seize will only be set, if the draw:image had been added to its draw:frame prior.- Parameters:
imageUri
- The URI of the image that will be added as stream to the package in the 'Pictures/' graphic directory with the same image file name as in the URI. If the imageURI is relative first the user.dir is taken to make it absolute.- Returns:
- Returns the package path of the image, which was created based on the given URI.
- Throws:
Exception
- If the image provided by the URI, could not be added as stream to the ODF package.
-
newImage
Inserts the image file from the stream to the ODF package named similar as in the provided path.. The manifest is adapted using given media type. Existing images are replaced.- Parameters:
is
- InputStream to be added to the ODF packagepackagePath
- Internal path of the image in the packagemediaType
- The mediaType of the image. Can be obtained by the OdfFileEntry class findMediaType(String fileRef).- Throws:
Exception
- If the given stream could not be added to the ODF package at the packagePatch
-
newImage
Inserts the image file from the stream to the ODF package named similar as in the provided path.. The manifest is adapted using given media type. Existing images are replaced.- Parameters:
fileBytes
- - data of the file stream to be stored in package. If NULL a directory with the given media type will be created.packagePath
- Internal path of the image in the packagemediaType
- The mediaType of the image. Can be obtained by the OdfFileEntry class findMediaType(String fileRef).- Throws:
Exception
- If the given stream could not be added to the ODF package at the packagePatch
-
getImageByPath
The method returns the specific one or more images by image path since the image may be inserted to the document several times.- Parameters:
doc
- the document the image belongs toimagePath
- the internal package path of the image.- Returns:
- an Image list that match the given image path if no images is found under the given path, return an empty list.
-
deleteImageByPath
The method deletes one or more images from image container by image path.- Parameters:
doc
- the document the image should be deleted fromimagePath
- the internal package path of the image.
-
deleteImage
The method deletes the specified image from image container.- Parameters:
doc
- the document the image should be deleted fromimage
- the image which need to be deleted
-
getImageCount
Get the count of image objects in the image container.- Parameters:
doc
- the document the image should be counted from- Returns:
- the number of image in this document if no image is found, return zero
-
getImages
The method return the image list in the image container.- Parameters:
doc
- the document the list of images should be returned from- Returns:
- an image list in this document if no images is found, return an empty list.
-
getImagePathSet
The method return the set of all the image paths.- Parameters:
doc
- the document the image path set should be obtained from- Returns:
- an image path set in this document
-