Language
Asturianu (ast)
Català (ca)
Čeština (cs)
Dansk (da)
Deutsch (de)
English [US] (en-US)
Español (es)
Esperanto (eo)
Eesti keel (et)
Euskara (eu)
Français (fr)
Gàidhlig (gd)
Galego (gl)
Italiano (it)
Lietuvių (lt)
Magyar (hu)
Nederlands (nl)
Norsk (no)
Polski (pl)
Português [do Brasil] (pt-BR)
Português [Europeu] (pt)
Română (ro)
Slovenčina (sk)
Slovenščina (sl)
Suomi (fi)
Svenska (sv)
Yкраїнська (uk)
Tiếng Việt (vi)
Türkçe (tr)
ኦሮሚኛ (om)
Հայերեն (hy)
Ελληνικά (el)
български език (bg)
Русский (ru)
Cрпски [ћирилицом] (sr)
עברית (he)
हिन्दी (hi)
ភាសាខ្មែរ (km)
தமிழ் (ta)
ภาษาไทย (th)
简体中文 (zh-CN)
正體中文 (zh-TW)
日本語 (ja)
한국어 (ko)
:: com :: sun :: star :: awt ::
interface XAnimatedImages
Base Interfaces XAnimatedImages
┗ ::com::sun::star::container ::XContainer
::com::sun::star::container ::XContainer
Description allows other components to observer the insertion, removal, and replacement of image sets
Description allows administrating a set of images, to be displayed as animated seres.
Components implementing this interface maintain a variable number of image sets. Components displaying
those images will choose the best-fitting image set depending on the available space, and possibly other
restrictions.
Since OOo 3.4
Methods' Summary
getImageSetCount returns the number of images sets maintained by the component.
getImageSet returns the URLs of the image set with the given index
insertImageSet sets the URLs of the image set with the given index
replaceImageSet replaces the image set given by index with a new one
removeImageSet removes the image set with the given index
Attributes' Summary
StepTime specifies the time in milliseconds between two animation steps.
AutoRepeat specifies whether the animation should start over with the first image of the image series when the last image
has been played.
ScaleMode controls the way the images are scaled up or down, when the available space is larger or smaller
than what is needed for them.
Methods' Details
getImageSetCount
Description returns the number of images sets maintained by the component.
getImageSet
Description returns the URLs of the image set with the given index
Parameter i_index the index of the set those image URLs are to be retrieved. Must be greater than or equal to 0,
and smaller than the value returned by getImageSetCount .
Throws ::com::sun::star::lang::IndexOutOfBoundsException
if the i_index is not a valid index.
insertImageSet
Description sets the URLs of the image set with the given index
Parameter i_index the index at which a new image set should be inserted. Must be greater than or equal to 0,
and smaller than or equal to the value returned by getImageSetCount .
Parameter i_imageURLs the URLs for the images for the given set. Will be resolved using a ::com::sun::star::graphic ::GraphicProvider .
Throws ::com::sun::star::lang::IndexOutOfBoundsException
if the i_index is not a valid index.
replaceImageSet
Description replaces the image set given by index with a new one
Parameter i_index the index of the set those image URLs are to be replaced. Must be greater than or equal to 0,
and smaller than the value returned by getImageSetCount .
Parameter i_imageURLs the URLs for the images for the given set. Will be resolved using a ::com::sun::star::graphic ::GraphicProvider .
Throws ::com::sun::star::lang::IndexOutOfBoundsException
if the i_index is not a valid index.
removeImageSet
Description removes the image set with the given index
Parameter i_index the index of the set to remove. Must be greater than or equal to 0,
and smaller than the value returned by getImageSetCount .
Throws ::com::sun::star::lang::IndexOutOfBoundsException
if the i_index is not a valid index.
Attributes' Details
StepTime
long StepTime ;
Description specifies the time in milliseconds between two animation steps.
This is the minimum time, the actual value might be longer due to
system load. The default value will be 100 ms.
AutoRepeat
boolean AutoRepeat ;
Description specifies whether the animation should start over with the first image of the image series when the last image
has been played.
The default value for this attribute is true .
ScaleMode
short ScaleMode
set raises (::com::sun::star::lang ::IllegalArgumentException );
Description controls the way the images are scaled up or down, when the available space is larger or smaller
than what is needed for them.
Allowed values are those from the ImageScaleMode constants group.
Top of Page Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
