Package com._1c.g5.v8.dt.platform.pictures

Interface IPictureManifest

All Known Subinterfaces:

IZipPictureManifest

All Known Implementing Classes:

AbsSinglePictureManifest, AbstractSinglePictureManifest, AbstractZipPictureManifest, AbsZipPictureManifest, Base64GraphicalSchemeSinglePictureManifest, Base64GraphicalSchemeZipPictureManifest, FormSinglePictureManifest, FormZipPictureManifest, GeographicalSchemaSinglePictureManifest, GeographicalSchemaZipPictureManifest, GraphicalSchemeSinglePictureManifest, GraphicalSchemeZipPictureManifest, LayoutSinglePictureManifest, LayoutZipPictureManifest, MdSinglePictureManifest, MdZipPictureManifest, PlatformSinglePictureManifest, PlatformZipPictureManifest, UrlSinglePictureManifest

public interface IPictureManifest

Picture manifest stores extended Picture properties and allow to access them by client queries.

Field Summary

Fields

Modifier and Type	Field	Description
static final IPictureManifest	UNRESOLVED_PICTURE_MANIFEST	Special implementation of IPictureManifest for cases when information about picture cannot be got.

Method Summary

Modifier and Type	Method	Description
CompositeId	getCompositeId()	The picture CompositeId
PictureDirectionVariant	getDirection(IPictureManifestQuery query)	The picture PictureDirectionVariant
Optional<InputStream>	getInputStream(IPictureManifestQuery query)	The picture InputStream
boolean	isTemplate(IPictureManifestQuery query)	Is picture is template

Field Details

UNRESOLVED_PICTURE_MANIFEST

static final IPictureManifest UNRESOLVED_PICTURE_MANIFEST

Special implementation of IPictureManifest for cases when information about picture cannot be got.
The real example of this case may be a PictureRef with reference to unresolved picture

Method Details

getCompositeId

CompositeId getCompositeId()

The picture CompositeId

Returns:

the CompositeId or null if picture without id.

isTemplate

boolean isTemplate(IPictureManifestQuery query)
            throws IOException

Is picture is template

Parameters:

query - the IPictureManifestQuery, cannot be null

Returns:

true if picture by given query is template, false in otherwise

Throws:

IOException - if there is a problem to read the picture content

PictureManifestException - if there is a problem to obtain the picture content or manifest

getDirection

PictureDirectionVariant getDirection(IPictureManifestQuery query)
                              throws IOException

The picture PictureDirectionVariant

Parameters:

query - the IPictureManifestQuery, cannot be null

Returns:

first suitable PictureDirectionVariant by the following algorithm:

Picture variant selection in LTR-interface (in order of priority):

1. Left to right
2. Left to right, can flip
3. Right to left, can flip
4. Any
5. Right to left

Picture variant selection in RTL-interface (in order of priority):

1. Right to left
2. Right to left, can flip
3. Left to right, can flip
4. Any
5. Left to right

Throws:

IOException - if there is a problem to read the picture content

getInputStream

Optional<InputStream> getInputStream(IPictureManifestQuery query)
                              throws IOException

The picture InputStream

The picture may be cropped if it contains enough information for this purpose.

Parameters:

query - the IPictureManifestQuery, cannot be null

Returns:

the InputStream of picture by given query, never null

Throws:

IOException - if there is a problem to read the picture content

PictureManifestException - if there is a problem to obtain the picture content or manifest