## Uses of Interface
org.zkoss.util.media.Media

- Packages that use Media
  Package | Description
  --- | ---
  org.zkoss.image |
  org.zkoss.sound |
  org.zkoss.stateless.action.data |
  org.zkoss.stateless.sul |
  org.zkoss.util.media |
  org.zkoss.video |
  org.zkoss.web.servlet.http |
  org.zkoss.zhtml |
  org.zkoss.zk.ui |
  org.zkoss.zk.ui.event |
  org.zkoss.zk.ui.ext.render |
  org.zkoss.zk.ui.impl |
  org.zkoss.zk.ui.sys |
  org.zkoss.zkex.zul |
  org.zkoss.zkmax.zul |
  org.zkoss.zul |
  org.zkoss.zul.impl |

- - ### Uses of Media in org.zkoss.image

    Subinterfaces of Media in org.zkoss.image
    Modifier and Type | Interface | Description
    --- | --- | ---
    `interface` | `Image` | Represents an image.

    Classes in org.zkoss.image that implement Media
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `AImage` | Represents an image.

  - ### Uses of Media in org.zkoss.sound

    Subinterfaces of Media in org.zkoss.sound
    Modifier and Type | Interface | Description
    --- | --- | ---
    `interface` | `Audio` | Represents an audio.

    Classes in org.zkoss.sound that implement Media
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `AAudio` | Represents an audio.

  - ### Uses of Media in org.zkoss.stateless.action.data

    Methods in org.zkoss.stateless.action.data that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | FileData.`getMedia()` | return the media if any.

    Methods in org.zkoss.stateless.action.data that return types with arguments of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.util.List<Media>` | FileData.`getMedias()` | return the medias if any.

  - ### Uses of Media in org.zkoss.stateless.sul

    Methods in org.zkoss.stateless.sul with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static java.lang.String` | IMediaBase.JSObjectUrl.`generate​(Media media)` |

  - ### Uses of Media in org.zkoss.util.media

    Classes in org.zkoss.util.media that implement Media
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `AMedia` | A media object holding content such PDF, HTML, DOC or XLS content.
    `class` | `RepeatableMedia` | `RepeatableMedia` adds functionality to another media, the ability to read repeatedly.

    Methods in org.zkoss.util.media that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Media` | RepeatableMedia.`getInstance​(Media media)` | Returns a repeatable media with a repeatable input stream or reader, or null if the given media is null.

    Methods in org.zkoss.util.media with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Media` | RepeatableMedia.`getInstance​(Media media)` | Returns a repeatable media with a repeatable input stream or reader, or null if the given media is null.

  - ### Uses of Media in org.zkoss.video

    Subinterfaces of Media in org.zkoss.video
    Modifier and Type | Interface | Description
    --- | --- | ---
    `interface` | `Video` | Represents a video.

    Classes in org.zkoss.video that implement Media
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `AVideo` | Represents a video.

  - ### Uses of Media in org.zkoss.web.servlet.http

    Methods in org.zkoss.web.servlet.http with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | Https.`write​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Media media, boolean download, boolean repeatable)` | Write the specified media to HTTP response.

  - ### Uses of Media in org.zkoss.zhtml

    Methods in org.zkoss.zhtml with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | Filedownload.`save​(Media media)` | Open a download dialog to save the specified content at the client.
    `static void` | Filedownload.`save​(Media media, java.lang.String flnm)` | Open a download dialog to save the specified content at the client with the suggested file name.

  - ### Uses of Media in org.zkoss.zk.ui

    Methods in org.zkoss.zk.ui with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.lang.String` | Desktop.`getDownloadMediaURI​(Media media, java.lang.String pathInfo)` | Returns URI for a media that is used to download to the client.

  - ### Uses of Media in org.zkoss.zk.ui.event

    Methods in org.zkoss.zk.ui.event that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | UploadEvent.`getMedia()` | Returns the first media being uploaded, or null if no file is uploaded.
    `Media[]` | UploadEvent.`getMedias()` | Returns the array of media being uploaded, or null if the user uploaded no file at all.

    Constructors in org.zkoss.zk.ui.event with parameters of type Media
    Constructor | Description
    --- | ---
    `UploadEvent​(java.lang.String name, Component target, Media[] meds)` | Constructs the upload event.

  - ### Uses of Media in org.zkoss.zk.ui.ext.render

    Methods in org.zkoss.zk.ui.ext.render that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | DynamicMedia.`getMedia​(java.lang.String pathInfo)` | Retrieve the view in `Media` format.

  - ### Uses of Media in org.zkoss.zk.ui.impl

    Methods in org.zkoss.zk.ui.impl that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | DesktopImpl.`getDownloadMedia​(java.lang.String medId, boolean reserved)` |

    Methods in org.zkoss.zk.ui.impl with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.lang.String` | DesktopImpl.`getDownloadMediaURI​(Media media, java.lang.String pathInfo)` |

  - ### Uses of Media in org.zkoss.zk.ui.sys

    Methods in org.zkoss.zk.ui.sys that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | DiskFileItemFactory.`createMedia​(org.apache.commons.fileupload2.core.FileItem fileItem, java.lang.String contentType, java.lang.String fileName, boolean isNative)` | Create a new `Media` instance from from the supplied parameters and any local factory configuration.
    `Media` | DesktopCtrl.`getDownloadMedia​(java.lang.String medId, boolean reserved)` | Returns the media that is associated with `Desktop.getDownloadMediaURI(org.zkoss.util.media.Media, java.lang.String)`, or null if not found.

  - ### Uses of Media in org.zkoss.zkex.zul

    Methods in org.zkoss.zkex.zul that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | Pdfviewer.`getContent()` | Returns the content set by `Pdfviewer.setContent(org.zkoss.util.media.Media)`.
    `Media` | Jasperreport.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | Pdfviewer.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | Jasperreport.`getReport()` | Returns a AMedia contains report's byte stream.

    Methods in org.zkoss.zkex.zul with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | Jasperreport.`setContent​(Media media)` | Sets the content directly.
    `void` | Pdfviewer.`setContent​(Media content)` | Sets the content.

  - ### Uses of Media in org.zkoss.zkmax.zul

    Methods in org.zkoss.zkmax.zul that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | Cropper.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | Lineitem.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | Video.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | FiledownloadListener.`onDownload​(Media media, java.lang.Object source, java.lang.String data)` | Notifies that the user is requesting the media to download.

    Methods in org.zkoss.zkmax.zul with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | FiledownloadListener.`onDownload​(Media media, java.lang.Object source, java.lang.String data)` | Notifies that the user is requesting the media to download.

  - ### Uses of Media in org.zkoss.zul

    Methods in org.zkoss.zul that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Media` | Fileupload.`get()` | Opens a modal dialog with the default message and title, and let user upload a file.
    `static Media` | Fileupload.`get​(boolean alwaysNative)` | Opens a modal dialog with the default message and title, and let user upload a file.
    `static Media[]` | Fileupload.`get​(int max)` | Opens a modal dialog to upload multiple files with the default message and title.
    `static Media[]` | Fileupload.`get​(int max, boolean alwaysNative)` | Opens a modal dialog to upload multiple files with the default message and title.
    `static Media[]` | Fileupload.`get​(int max, EventListener<UploadEvent> listener)` | Opens a modal dialog to upload multiple files with the default message and title.
    `static Media` | Fileupload.`get​(java.lang.String message, java.lang.String title)` | Opens a modal dialog with the specified message and title, and let user upload a file.
    `static Media` | Fileupload.`get​(java.lang.String message, java.lang.String title, boolean alwaysNative)` | Opens a modal dialog with the specified message and title, and let user upload a file.
    `static Media[]` | Fileupload.`get​(java.lang.String message, java.lang.String title, int max)` | Opens a modal dialog to upload multiple files with the specified message and title.
    `static Media[]` | Fileupload.`get​(java.lang.String message, java.lang.String title, int max, boolean alwaysNative)` | Opens a modal dialog to upload multiple files with the specified message, title and options.
    `static Media[]` | Fileupload.`get​(java.lang.String message, java.lang.String title, int max, int maxsize, boolean alwaysNative)` | Opens a modal dialog to upload multiple files with the specified message, title and options.
    `protected static Media[]` | Fileupload.`get​(java.util.Map<java.lang.String,​java.lang.Object> params, java.lang.String message, java.lang.String title, int max, int maxsize, boolean alwaysNative)` | The implementation of all public get methods.
    `static Media[]` | Fileupload.`get​(java.util.Map<java.lang.String,​java.lang.Object> params, java.lang.String message, java.lang.String title, int max, int maxsize, boolean alwaysNative, EventListener<UploadEvent> listener)` | Opens a modal dialog to upload multiple files with the specified message, title and options.
    `static Media[]` | Fileupload.`get​(java.util.Map<java.lang.String,​java.lang.Object> params, java.lang.String message, java.lang.String title, java.lang.String accept, int max, int maxsize, boolean alwaysNative, EventListener<UploadEvent> listener)` | Opens a modal dialog to upload multiple files with the specified message, title and options.
    `static Media[]` | Fileupload.`get​(EventListener<UploadEvent> listener)` | Opens a modal dialog to upload multiple files with the default message and title.
    `Media` | Iframe.`getContent()` | Returns the content set by `Iframe.setContent(org.zkoss.util.media.Media)`.
    `Media` | Audio.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | Filedownload.DownloadItem.`getMedia()` |
    `Media` | Iframe.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media` | Image.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |

    Methods in org.zkoss.zul with parameters of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Filedownload.DownloadItem` | Filedownload.DownloadItem.`of​(Media media)` | Static factory method to create a download item using media's original filename.
    `static Filedownload.DownloadItem` | Filedownload.DownloadItem.`of​(Media media, java.lang.String filename)` | Static factory method to create a download item with custom filename.
    `static void` | Filedownload.`save​(Media media)` | Open a download dialog to save the specified content at the client.
    `static void` | Filedownload.`save​(Media media, java.lang.String flnm)` | Open a download dialog to save the specified content at the client with the suggested file name.
    `static void` | Filedownload.`saveAsZip​(Media[] medias, java.lang.String zipFilename)` | Downloads multiple media files as a single ZIP archive.
    `static void` | Filedownload.`saveMultiple​(Media... medias)` | Downloads multiple media files using their original filenames.
    `void` | Iframe.`setContent​(Media media)` | Sets the content directly.

    Method parameters in org.zkoss.zul with type arguments of type Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | Filedownload.`saveAsZip​(java.util.Map<Media,​java.lang.String> mediaMap, java.lang.String zipFilename)` | Downloads multiple media files with custom names as a single ZIP archive.
    `static void` | Filedownload.`saveMultiple​(java.util.Map<Media,​java.lang.String> mediaMap)` | Downloads multiple media files with custom filenames.

    Constructors in org.zkoss.zul with parameters of type Media
    Constructor | Description
    --- | ---
    `DownloadItem​(Media media)` | Creates a download item using the media's original filename.
    `DownloadItem​(Media media, java.lang.String filename)` | Creates a download item with custom filename.

  - ### Uses of Media in org.zkoss.zul.impl

    Methods in org.zkoss.zul.impl that return Media
    Modifier and Type | Method | Description
    --- | --- | ---
    `Media` | LabelImageElement.ExtraCtrl.`getMedia​(java.lang.String pathInfo)` |
    `Media[]` | FileuploadDlg.`getResult()` | Returns the result.