87. setImageMode
Prev | Chapter 6. Commands written in the Java™ programming language | Next

## 87. setImageMode

Parameter syntax:

    [ '[all]' S ]? [ 'image'|'thumbnail'|'box'|'unset' ]?

This command changes the way images are displayed in the styled view.

If option `[all]` is specified, the command acts on the styled view, that is, on all the images found in the styled view. Otherwise, the command acts on the explicitly selected element, when this element is styled using `content: image-viewport(`arguments`);` (Section 25, “image-viewport” in XMLmind XML Editor - Support of Cascading Style Sheets (W3C CSS)).

`image`

  Display the image normally, that is, possibly scaled if this has been specified using attributes such as `width` and `height`.

`thumbnail`

  Show the bounding box of the (possibly scaled) image and, if there is enough room in this rectangle, also show a thumbnail (at most 128x128 pixels large).

`box`

  Show the bounding box of the (possibly scaled) image.

  Note that options `thumbnail` and `box` have no effect on images having an intrinsic size smaller than 32x32 pixels. Such small images are always displayed normally.

`unset`

  Discard the current display mode.

  In fact, this command changes the display mode of the selected image viewport.

  Discarding the mode which is specific to an image viewport means that this viewport will have to use the mode which is specific to the styled view containing it (previously specified using Display Images in XMLmind XML Editor - Online Help or using this command with the `[all]` option).

  If this styled view has no specific mode, then the viewport will have to fallback to the application-wide display mode (previously specified using Display images in XMLmind XML Editor - Online Help).

Without any argument, this command simply updates the view of the selected image. This is useful if, for example, the image file has changed on the disk.

Examples:

    setImageMode
    setImageMode box
    setImageMode unset

    setImageMode [all] thumbnails
    setImageMode [all] image
    setImageMode [all] unset

Prev | Up | Next
86. selectTo | Home | 88. setProperty