palio.modules
Class Mapper

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

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Mapper
extends Module

Moduł służy do rysowania map (także nawigowalnych) w dokumentach HTML.

Konstruowanie map.

Do generacji map służą dwie funkcje, createMap() i createNavMap(), tworzące odpowiednio zwykłą i nawigowalną mapę. Jako jeden z argumentów przyjmują one kod Palio, w którym należy zawrzeć wywołania metody addRegion(), która tworzy pojedynczy obszar mapy.

Uwaga: metody z wersji <0.6, generujące mapę z tablicy parametrów zostały usunięte.

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

Version:

1.6.2

Author:

Leszek Leszczyński (lleszczynski@torn.com.pl)

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

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

Method Summary

void	addRegion(java.lang.String label, java.lang.String link, java.util.List<java.lang.Object[]> coords, java.lang.String fillColor, java.lang.String borderColor, java.lang.String title) Dodaje region do mapy.
void	addRegion(java.lang.String label, java.lang.String link, java.lang.String coords, java.lang.String fillColor, java.lang.String borderColor, java.lang.String title) Dodaje region do mapy.
java.lang.String	connectRegions(palio.compiler.PalioCode code) Łączy regiony w jeden duży region.
java.lang.String	createMap(java.lang.String mapName, java.lang.Long width, java.lang.String fillColorString, java.lang.String borderColorString, java.lang.Boolean antialiased, palio.compiler.PalioCode code) Tworzy mapę bez nawigacji.
java.lang.String	createNavMap(java.lang.String mapName, java.lang.Long width, java.lang.String fillColorString, java.lang.String borderColorString, java.lang.Boolean antialiased, palio.compiler.PalioCode code) Tworzy nawigowalną mapę.
static java.math.BigDecimal	distance(java.math.BigDecimal lat1, java.math.BigDecimal lon1, java.math.BigDecimal lat2, java.math.BigDecimal lon2) Oblicza odległość pomiędzy dwiema lokalizacjami geograficznymi.
java.lang.String	getVersion() Returns the module version
static java.math.BigDecimal	latToKms(java.math.BigDecimal lat) Przelicza odległość równoleżnika od równika (w kilometrach)
static java.math.BigDecimal	lonToKms(java.math.BigDecimal lon, java.math.BigDecimal lat) Przelicza odległość południka od Greenwich (w kilometrach)

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

Mapper

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

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: Module

Returns the module version

Specified by:

getVersion in class Module

connectRegions

public java.lang.String connectRegions(palio.compiler.PalioCode code)
                                throws palio.PalioException

Łączy regiony w jeden duży region. Kod tworzenia super-regionu jest identyczny jak w przypadku normalnej mapy (dodawane są regiony).

Throws:

palio.PalioException

createMap

public java.lang.String createMap(java.lang.String mapName,
                                  java.lang.Long width,
                                  java.lang.String fillColorString,
                                  java.lang.String borderColorString,
                                  java.lang.Boolean antialiased,
                                  palio.compiler.PalioCode code)
                           throws palio.PalioException

Tworzy mapę bez nawigacji. Mapa jest wyświetlana jako obraz typu PNG.

Parameters:

mapName - nazwa mapy- musi być unikalna w pojedynczym wywołaniu strony.

width - szerokość mapy w pikselach; wysokość mapy jest dobierana automatycznie.

fillColorString - domyślne wypełnienie w formacie rrggbb (hex).

borderColorString - domyślny kolor krawędzi w formacie rrggbb (hex).

antialiased - czy wygładzać krawędzie (true- tak).

code - kod generacji mapy

Returns:

kod do wstawienia na stronę.

Throws:

palio.PalioException

createNavMap

public java.lang.String createNavMap(java.lang.String mapName,
                                     java.lang.Long width,
                                     java.lang.String fillColorString,
                                     java.lang.String borderColorString,
                                     java.lang.Boolean antialiased,
                                     palio.compiler.PalioCode code)
                              throws palio.PalioException

Tworzy nawigowalną mapę. Mapa jest wyświetlana jako obraz typu PNG.

Parameters:

mapName - nazwa mapy- musi być unikalna w pojedynczym wywołaniu strony.

width - szerokość mapy w pikselach; wysokość mapy jest dobierana automatycznie.

fillColorString - domyślne wypełnienie w formacie rrggbb (hex).

borderColorString - domyślny kolor krawędzi w formacie rrggbb (hex).

antialiased - czy wygładzać krawędzie (true- tak).

code - kod generacji mapy

Returns:

kod do wstawienia na stronę.

Throws:

palio.PalioException

addRegion

public void addRegion(java.lang.String label,
                      java.lang.String link,
                      java.lang.String coords,
                      java.lang.String fillColor,
                      java.lang.String borderColor,
                      java.lang.String title)

Dodaje region do mapy.

Parameters:

label - etykieta (atrybut <title> odpowiedniego obszaru mapy HTML)

link - łącze związane z regionem (ważne tylko w przypadku mapy nawigowalnej)

coords - koordynaty regionu w postaci ciągu znaków rozdzielonego spacjami: opis pojedynczego wierzchołka ma postać "A x y", gdzie A- akcja (M- moveTo, L- lineTo), x,y- współrzędne wierzchołka. Pierwszy wierzchołek musi mieć akcję "M".

fillColor - kolor wypełnienia w postaci rrggbb (hex).

borderColor - kolor krawędzi w postaci rrggbb (hex).

title - etykieta wyświetlana na obrazie mapy

addRegion

public void addRegion(java.lang.String label,
                      java.lang.String link,
                      java.util.List<java.lang.Object[]> coords,
                      java.lang.String fillColor,
                      java.lang.String borderColor,
                      java.lang.String title)

Dodaje region do mapy.

Parameters:

label - etykieta (atrybut <title> odpowiedniego obszaru mapy HTML)

link - łącze związane z regionem (ważne tylko w przypadku mapy nawigowalnej)

coords - koordynaty regionu w postaci listy z wierzchołkami: opis pojedynczego wierzchołka ma postać tablicy elementów [A, x, y]", gdzie A- akcja (M- moveTo, L- lineTo), a x i y- współrzędne wierzchołka. Pierwszy wierzchołek musi mieć akcję "M".

fillColor - kolor wypełnienia w postaci rrggbb (hex).

borderColor - kolor krawędzi w postaci rrggbb (hex).

title - etykieta wyświetlana na obrazie mapy

Since:

jPALIO 6.8.6, module 1.6.2

distance

public static java.math.BigDecimal distance(java.math.BigDecimal lat1,
                                            java.math.BigDecimal lon1,
                                            java.math.BigDecimal lat2,
                                            java.math.BigDecimal lon2)

Oblicza odległość pomiędzy dwiema lokalizacjami geograficznymi.

Parameters:

lat1 - szerokość geograficzna punktu startowego (w stopniach- wartości dodatnie na północ od równika)

lon1 - długość geograficzna punktu startowego

lat2 - szerokość geog. punktu docelowego (w stopniach - wartości dodatnie na wschód od Greenwich)

lon2 - długość geog. punktu docelowego

Returns:

odległość w kilometrach

lonToKms

public static java.math.BigDecimal lonToKms(java.math.BigDecimal lon,
                                            java.math.BigDecimal lat)

Przelicza odległość południka od Greenwich (w kilometrach)

Parameters:

lon - długość geograficzna w stopniach (w stopniach - wartości dodatnie na wschód od Greenwich)

lat - szerokość geograficzna w stopniach (w stopniach- wartości dodatnie na północ od równika)

Returns:

odległość w kilometrach

latToKms

public static java.math.BigDecimal latToKms(java.math.BigDecimal lat)

Przelicza odległość równoleżnika od równika (w kilometrach)

Parameters:

lat - szerokość geograficzna w stopniach (w stopniach - wartości dodatnie na północ od równika)

Returns:

odległość w kilometrach