org.docgene.model

Class XMLVideo

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.XMLVideo

All Implemented Interfaces:

Alignment, ElementReference, ExternalLink, ParagraphElement, StyledElement

public class XMLVideo
extends AbstractLink
implements Alignment

Represent an link to an embedded video.

Field Summary

Fields

Modifier and Type	Field and Description
static short	DAILYMOTION The dailymotion video type.
static float	FACTOR The Heiht / Width factor.
static short	MP4 The MP4 video type.
static short	OGG The OGG video type.
static short	WEBM The WEBM video type.
static short	YOUTUBE The youtube video type.

Fields inherited from class org.docgene.model.AbstractLink

isAbsolute, isValid

Fields inherited from interface org.docgene.model.Alignment

CENTER, LEFT, RIGHT

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLVideo(short type) Create an embdeed video link.

Method Summary

Modifier and Type	Method and Description
char	getAlignment() Return the alignment of the video.
java.lang.String	getDeclaration() Return the declaration ID of the element.
int	getHeight() Return the image height.
java.lang.String	getPath() Return the link path.
java.lang.String	getText() Return null.
short	getType() Return the video type.
java.net.URL	getURL() Return the link URL.
java.lang.String	getVideoURL() Return the link to the video.
int	getWidth() Return the image width.
boolean	hasHeight() Return true if the image has a specified height.
boolean	hasWidth() Return true if the image has a specified width.
void	setAlignment(char align) Set the alignment of the video.
void	setHeight(int height) Set the video height.
void	setPath(java.lang.String path) Set the video path
void	setWidth(int width) Set the video width.

Methods inherited from class org.docgene.model.AbstractLink

getCustomStyles, getLineNumber, isAbsolute, isValid, setCustomStyles, setLineNumber, setValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.ExternalLink

getNotNullURL, getURLAsString, getURLAsString, getURLAsString

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Field Detail

YOUTUBE

public static final short YOUTUBE

The youtube video type.

See Also:

Constant Field Values

DAILYMOTION

public static final short DAILYMOTION

The dailymotion video type.

See Also:

Constant Field Values

OGG

public static final short OGG

The OGG video type.

See Also:

Constant Field Values

MP4

public static final short MP4

The MP4 video type.

See Also:

Constant Field Values

WEBM

public static final short WEBM

The WEBM video type.

See Also:

Constant Field Values

FACTOR

public static final float FACTOR

The Heiht / Width factor.

See Also:

Constant Field Values

Constructor Detail

XMLVideo

public XMLVideo(short type)

Create an embdeed video link.

Parameters:

type - the video type

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

getType

public short getType()

Return the video type.

Returns:

the video type

getVideoURL

public java.lang.String getVideoURL()

Return the link to the video.

Returns:

the link to the video

setPath

public void setPath(java.lang.String path)
             throws java.net.MalformedURLException

Set the video path

Parameters:

path - the video path

Throws:

java.net.MalformedURLException - if the path is an invalid URL

setAlignment

public void setAlignment(char align)

Set the alignment of the video.

Specified by:

setAlignment in interface Alignment

Parameters:

align - the alignment

See Also:

Alignment

getAlignment

public char getAlignment()

Return the alignment of the video.

Specified by:

getAlignment in interface Alignment

Returns:

the alignment

See Also:

Alignment

setWidth

public void setWidth(int width)

Set the video width.

Parameters:

width - the video width

setHeight

public void setHeight(int height)

Set the video height.

Parameters:

height - the video height

getWidth

public int getWidth()

Return the image width.

Returns:

the image width

getHeight

public int getHeight()

Return the image height.

Returns:

the image height

hasWidth

public boolean hasWidth()

Return true if the image has a specified width.

Returns:

true if the image has a specified width

hasHeight

public boolean hasHeight()

Return true if the image has a specified height.

Returns:

true if the image has a specified height

getURL

public java.net.URL getURL()

Return the link URL.

Specified by:

getURL in interface ExternalLink

Returns:

the link URL

getText

public java.lang.String getText()

Return null.

Specified by:

getText in interface ExternalLink

Returns:

null

getPath

public java.lang.String getPath()

Return the link path.

Specified by:

getPath in interface ExternalLink

Returns:

the link path