com.aspose.note

Class Image

java.lang.Object

com.aspose.note.Node

com.aspose.note.Image

All Implemented Interfaces:

INode, IOutlineElementChildNode, IPageChildNode, ITaggable

public final class Image
extends Node
implements IPageChildNode, IOutlineElementChildNode, ITaggable

Represents an Image.

Constructor Summary

Constructors

Constructor and Description
Image(Document document, String path) Initializes a new instance of the Image class.
Image(Document document, String fileName, InputStream imageStream) Initializes a new instance of the Image class.

Method Summary

Modifier and Type	Method and Description
void	accept(DocumentVisitor visitor) Accepts the visitor of the node.
int	getAlignment() Gets the alignment.
String	getAlternativeTextDescription() Gets a body an alternative text for the image.
String	getAlternativeTextTitle() Gets a title of alternative text for the image.
byte[]	getBytes() Gets the image data store.
String	getFileName() Gets the file name.
String	getFilePath() Gets the path to the image file.
com.aspose.ms.System.Drawing.Imaging.ImageFormat	getFormat() Gets the image's format.
float	getHeight() Gets the height.
float	getHorizontalOffset() Gets the horizontal offset.
String	getHyperlinkUrl() Gets the hyperlink associated with the image.
Date	getLastModifiedTime() Gets last modified time.
float	getOriginalHeight() Gets the original height.
float	getOriginalWidth() Gets the original width.
com.aspose.ms.System.Collections.Generic.List<ITag>	getTags() Gets the list of all tags of an image.
float	getVerticalOffset() Gets the vertical offset.
float	getWidth() Gets the width.
boolean	isBackground() Gets whether the image is a background image.
void	setAlignment(int value) Sets the alignment.
void	setAlternativeTextDescription(String value) Sets a body an alternative text for the image.
void	setAlternativeTextTitle(String value) Sets a title of alternative text for the image.
void	setBackground(boolean value) Gets whether the image is a background image.
void	setHeight(float value) Sets the height.
void	setHorizontalOffset(float value) Sets the horizontal offset.
void	setHyperlinkUrl(String value) Sets the hyperlink associated with the image.
void	setLastModifiedTime(Date value) Sets last modified time.
void	setVerticalOffset(float value) Sets the vertical offset.
void	setWidth(float value) Sets the width.

Methods inherited from class com.aspose.note.Node

getDocument, getNextSibling, getNodeType, getParentNode, getPreviousSibling, isComposite

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.note.INode

getNextSibling, getPreviousSibling

Constructor Detail

Image

public Image(Document document,
             String path)

Initializes a new instance of the Image class.

Parameters:

document - A parent document of the image.

path - A string that contains the path to the file from which to create the Image.

Image

public Image(Document document,
             String fileName,
             InputStream imageStream)

Initializes a new instance of the Image class.

Parameters:

document - A parent document of the image.

fileName - A name of the image.

imageStream - A stream which contains the image.

Method Detail

getLastModifiedTime

public Date getLastModifiedTime()

Gets last modified time.

setLastModifiedTime

public void setLastModifiedTime(Date value)

Sets last modified time.

getWidth

public float getWidth()

Gets the width. This is the real width of the image in the MS OneNote document.

setWidth

public void setWidth(float value)

Sets the width. This is the real width of the image in the MS OneNote document.

getHeight

public float getHeight()

Gets the height. This is the real height of the image in the MS OneNote document.

setHeight

public void setHeight(float value)

Sets the height. This is the real height of the image in the MS OneNote document.

isBackground

public final boolean isBackground()

Gets whether the image is a background image.

setBackground

public final void setBackground(boolean value)

Gets whether the image is a background image.

getOriginalWidth

public float getOriginalWidth()

Gets the original width. This is the original width of the image, before resizing.

getOriginalHeight

public float getOriginalHeight()

Gets the original height. This is the original width of the image, before resizing.

getHorizontalOffset

public float getHorizontalOffset()

Gets the horizontal offset.

Specified by:

getHorizontalOffset in interface IPageChildNode

setHorizontalOffset

public void setHorizontalOffset(float value)

Sets the horizontal offset.

Specified by:

setHorizontalOffset in interface IPageChildNode

getVerticalOffset

public float getVerticalOffset()

Gets the vertical offset.

Specified by:

getVerticalOffset in interface IPageChildNode

setVerticalOffset

public void setVerticalOffset(float value)

Sets the vertical offset.

Specified by:

setVerticalOffset in interface IPageChildNode

getFilePath

public String getFilePath()

Gets the path to the image file.

getFileName

public String getFileName()

Gets the file name.

getFormat

public final com.aspose.ms.System.Drawing.Imaging.ImageFormat getFormat()

Gets the image's format.

getBytes

public byte[] getBytes()

Gets the image data store.

getTags

public final com.aspose.ms.System.Collections.Generic.List<ITag> getTags()

Gets the list of all tags of an image.

Specified by:

getTags in interface ITaggable

getAlignment

public int getAlignment()

Gets the alignment.

Returns:

The HorizontalAlignment.

setAlignment

public void setAlignment(int value)

Sets the alignment.

getAlternativeTextTitle

public final String getAlternativeTextTitle()

Gets a title of alternative text for the image.

setAlternativeTextTitle

public final void setAlternativeTextTitle(String value)

Sets a title of alternative text for the image.

getAlternativeTextDescription

public final String getAlternativeTextDescription()

Gets a body an alternative text for the image.

setAlternativeTextDescription

public final void setAlternativeTextDescription(String value)

Sets a body an alternative text for the image.

getHyperlinkUrl

public String getHyperlinkUrl()

Gets the hyperlink associated with the image.

setHyperlinkUrl

public void setHyperlinkUrl(String value)

Sets the hyperlink associated with the image.

accept

public void accept(DocumentVisitor visitor)

Accepts the visitor of the node.

Specified by:

accept in interface INode

Specified by:

accept in class Node

Parameters:

visitor - The object of a class derived from the DocumentVisitor.