Package de.digitalcollections.iiif.model.sharedcanvas

Class Canvas

java.lang.Object

de.digitalcollections.iiif.model.sharedcanvas.Resource<Canvas>

de.digitalcollections.iiif.model.sharedcanvas.Canvas

All Implemented Interfaces:

Choice<Canvas>

public class Canvas
extends Resource<Canvas>

A virtual container that represents a page or view and has content resources associated with it or with parts of it.

The canvas provides a frame of reference for the layout of the content. The concept of a canvas is borrowed from standards like PDF and HTML, or applications like Photoshop and Powerpoint, where the display starts from a blank canvas and images, text and other resources are “painted” on to it.

See http://iiif.io/api/presentation/2.1/#canvas

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE

Fields inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

_context, CONTEXT

Constructor Summary

Constructors

Constructor	Description
Canvas(String identifier)
Canvas(String identifier, String label)

Method Summary

Modifier and Type	Method	Description
Canvas	addIIIFImage(String serviceUrl, ImageApiProfile profile)
Canvas	addImage(ImageContent first, ImageContent... rest)
Canvas	addOtherContent(AnnotationList first, AnnotationList... rest)
Integer	getHeight()
List<Annotation>	getImages()
List<AnnotationList>	getOtherContent()
Set<ViewingHint.Type>	getSupportedViewingHintTypes()
String	getType()
Integer	getWidth()
void	setHeight(Integer height)
void	setImages(List<Annotation> images)	Sets the image annotations on this canvas.
void	setOtherContent(List<AnnotationList> otherContent)
void	setWidth(Integer width)
void	setWidthFromImage(Annotation imageAnno)

Methods inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

addAttribution, addDescription, addLabel, addLicense, addLogo, addLogo, addMetadata, addMetadata, addRelated, addRendering, addSeeAlso, addService, addThumbnail, addViewingHint, addWithin, getAlternatives, getAttribution, getAttributionString, getDescription, getDescriptionString, getFirstLicense, getIdentifier, getLabel, getLabelString, getLicenses, getLogos, getLogoUri, getMetadata, getRelated, getRenderings, getSeeAlso, getServices, getThumbnail, getThumbnails, getViewingHints, getWithin, isDefaultChoice, setAlternatives, setAttribution, setDescription, setIdentifier, setIsDefaultChoice, setLabel, setLicenses, setLogos, setRelated, setRenderings, setSeeAlso, setServices, setThumbnails, setViewingHints, setWithin, toString, verifyRendering

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.digitalcollections.iiif.model.openannotation.Choice

addAlternative

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

Canvas

public Canvas(String identifier)

Canvas

public Canvas(String identifier,
              String label)

Method Detail

getType

public String getType()

Overrides:

getType in class Resource<Canvas>

getImages

public List<Annotation> getImages()

setImages

public void setImages(List<Annotation> images)
               throws IllegalArgumentException

Sets the image annotations on this canvas. Must all be instances of ImageContent

Parameters:

images - image annotations on this canvas

Throws:

IllegalArgumentException - if at least one of the image annotations is not an ImageContent

addIIIFImage

public Canvas addIIIFImage(String serviceUrl,
                           ImageApiProfile profile)

addImage

public Canvas addImage(ImageContent first,
                       ImageContent... rest)

setWidthFromImage

public void setWidthFromImage(Annotation imageAnno)

getWidth

public Integer getWidth()

getHeight

public Integer getHeight()

setWidth

public void setWidth(Integer width)

setHeight

public void setHeight(Integer height)

getOtherContent

public List<AnnotationList> getOtherContent()

setOtherContent

public void setOtherContent(List<AnnotationList> otherContent)

addOtherContent

public Canvas addOtherContent(AnnotationList first,
                              AnnotationList... rest)

getSupportedViewingHintTypes

public Set<ViewingHint.Type> getSupportedViewingHintTypes()

Overrides:

getSupportedViewingHintTypes in class Resource<Canvas>