palio.modules
Class Imager

java.lang.Object
  palio.modules.core.Module
      palio.modules.Imager

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Imager
extends Module

Moduł do operacji na obrazach graficznych.

Obrazy są reprezentowane przez obiekty klasy ImageData, ale dla uproszczenia wszystkie metody jako argument przyjmują obiekty klasy Object (w przypadku przekazania nieprawidłowego obiektu generowany jest błąd)

Aby wyświetlić przetworzony obraz, należy wywołać metodę imageURL.

Moduł jest dostępny w każdej instancji jPalio.

Version:

1.0.2

Author:

Leszek Leszczyński

Field Summary

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

Imager(Instance instance, java.util.Properties parameters)

Method Summary

static ImageData	blur(java.lang.Object image) Rozmywa obraz.
static java.lang.Object	createImage(byte[] data, java.lang.String filetype) Tworzy obiekt graficzny z surowych danych.
static byte[]	getBytes(java.lang.Object image) Zwraca obraz w postaci surowych danych.
java.lang.String	getVersion() Zwraca numer wersji modułu
static java.lang.Object[]	imageSize(java.lang.Object image) Zwraca rozmiar obrazu.
java.lang.String	imageURL(java.lang.Object image, java.lang.String filename) Zwraca fizyczny adres wygenerowanego obrazu.
java.lang.String	imageURL(java.lang.Object image, java.lang.String filename, java.lang.Boolean forceAbsoluteURL) Zwraca fizyczny adres wygenerowanego obrazu.
static ImageData	resize(java.lang.Object image, java.lang.Long sizeX, java.lang.Long sizeY) Skaluje obraz.
static ImageData	sharpen(java.lang.Object image) Wyostrza obraz.
static ImageData	thumbnail(java.lang.Object image, java.lang.Long sizeX, java.lang.Long sizeY) Deprecated. replaced by thumbnail(Object,Long,Long,Boolean)
static ImageData	thumbnail(java.lang.Object image, java.lang.Long sizeX, java.lang.Long sizeY, java.lang.Boolean crop) Tworzy miniaturę obrazu, czyli obraz o podanym rozmiarze, ale z zachowaniem proporcji.

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Imager

public Imager(Instance instance,
              java.util.Properties parameters)

Method Detail

getVersion

public java.lang.String getVersion()

Zwraca numer wersji modułu

Specified by:

getVersion in class Module

imageURL

public java.lang.String imageURL(java.lang.Object image,
                                 java.lang.String filename)
                          throws palio.PalioException

Zwraca fizyczny adres wygenerowanego obrazu.

Parameters:

image - obiekt obrazu

filename - nazwa pliku, pod jaką obraz ma być wysłany do przeglądarki

Returns:

adres URL obrazu

Throws:

palio.PalioException

imageURL

public java.lang.String imageURL(java.lang.Object image,
                                 java.lang.String filename,
                                 java.lang.Boolean forceAbsoluteURL)
                          throws palio.PalioException

Zwraca fizyczny adres wygenerowanego obrazu.

Parameters:

image - obiekt obrazu

filename - nazwa pliku, pod jaką obraz ma być wysłany do przeglądarki

forceAbsoluteURL - czy wymusić pełny URL w adresie obrazka

Returns:

adres URL obrazu

Throws:

palio.PalioException

createImage

public static java.lang.Object createImage(byte[] data,
                                           java.lang.String filetype)
                                    throws palio.PalioException

Tworzy obiekt graficzny z surowych danych.

Parameters:

data - surowe dane

filetype - format danych - "JPG" lub "PNG"

Returns:

obiekt obrazu

Throws:

palio.PalioException

getBytes

public static byte[] getBytes(java.lang.Object image)
                       throws palio.PalioException

Zwraca obraz w postaci surowych danych.

Parameters:

image - obiekt obrazu

Returns:

dane obrazu

Throws:

palio.PalioException

resize

public static ImageData resize(java.lang.Object image,
                               java.lang.Long sizeX,
                               java.lang.Long sizeY)
                        throws palio.PalioException

Skaluje obraz.

Parameters:

image - obiekt obrazu

sizeX - nowy rozmiar X

sizeY - nowy rozmiar Y

Returns:

przeskalowany obraz

Throws:

palio.PalioException

thumbnail

@Deprecated
public static ImageData thumbnail(java.lang.Object image,
                                             java.lang.Long sizeX,
                                             java.lang.Long sizeY)
                           throws palio.PalioException

Deprecated. replaced by thumbnail(Object,Long,Long,Boolean)

Tworzy miniaturę obrazu, czyli obraz o podanym rozmiarze, ale z zachowaniem proporcji; część obrazu może zostać obcięta.

Parameters:

image - obiekt obrazu

sizeX - nowy rozmiar X

sizeY - nowy rozmiar Y

Returns:

miniatura obrazu

Throws:

palio.PalioException

thumbnail

public static ImageData thumbnail(java.lang.Object image,
                                  java.lang.Long sizeX,
                                  java.lang.Long sizeY,
                                  java.lang.Boolean crop)
                           throws palio.PalioException

Tworzy miniaturę obrazu, czyli obraz o podanym rozmiarze, ale z zachowaniem proporcji. Jeżeli argument "crop" będzie true, obraz może zostać przycięty, w taki sposób, aby wypełnić całkowicie podany rozmiar. W przeciwnym przypadku wynikowy obraz nie zostanie przycięty i może mieć rozmiar różny od podanego.

Parameters:

image - obiekt obrazu

sizeX - nowy rozmiar X

sizeY - nowy rozmiar Y

crop - czy obcinać obraz

Returns:

miniatura obrazu

Throws:

palio.PalioException

sharpen

public static ImageData sharpen(java.lang.Object image)
                         throws palio.PalioException

Wyostrza obraz. Uwaga- filtr jest raczej mocny, używać z umiarem.

Parameters:

image - obiekt obrazu

Returns:

wyostrzony obraz

Throws:

palio.PalioException

blur

public static ImageData blur(java.lang.Object image)
                      throws palio.PalioException

Rozmywa obraz.

Parameters:

image - obiekt obrazu

Returns:

rozmyty obraz

Throws:

palio.PalioException

imageSize

public static java.lang.Object[] imageSize(java.lang.Object image)
                                    throws palio.PalioException

Zwraca rozmiar obrazu.

Parameters:

image - obiekt obrazu

Returns:

rozmiar obrazu w postaci tablicy [szerokość, wysokość]

Throws:

palio.PalioException