webcore
Class HtmlUtils

java.lang.Object
  |
  +--webcore.HtmlUtils

public final class HtmlUtils

extends java.lang.Object

Kirjastoluokka, johon on kerätty hyödyllisiä apumetodeja muiden webcore-pakkauksen luokkien käyttöön.

Täältä löytyy mm. metodit navigaatiopalkin tulostamiseen sekä HTTP-otsikkotietojen asettamiseen.

Method Summary

static java.lang.String	convertSpace(java.lang.String in) Muuttaa välilyönnit ja rivinvaihdot yms.
static java.lang.String	convertTag2Entity(java.lang.String in) Muuttaa < ja > -merkit &lt; ja &gt; -merkeiksi
static java.lang.String	cookieHeader(long sessionId) Palauttaa HTTP-headerin joka lähettää selaimelle cookiena parametrina saatavan session-ID:n
static void	main(java.lang.String[] args) Pääohjelmametodi testausta varten.
static java.lang.String	normalize(java.lang.String in) Kutsutaan removeTag, removeQuot ja removeSpace -metodeja.
static void	printEmergencyExitPage(java.io.PrintWriter pw) Palauttaa selaimelle sivun joka uudelleenohjautuu Login-sivulle ja poistaa samalla session-id -keksin.
static void	printEndOfPage(java.io.PrintWriter pw) Tulostaa annettuun PrintWriteriin HTML-sivun lopun
static java.lang.String	printHeader(java.lang.String contentType, long length, java.lang.String fileName) Palauttaa HTTP-protokollan mukaiset WWW-palvelimen otsikkotiedot liitetiedostojen lähetystä varten.
static java.lang.String	printHeader(java.lang.String contentType, java.lang.String fileName) Palauttaa HTTP-protokollan mukaiset WWW-palvelimen otsikkotiedot liitetiedostojen lähetystä varten.
static void	printNavigationBar(java.io.PrintWriter pw) Tulostaa annettuu PrintWriteriin käyttöliittymän "navigaatiopalkin", eli lähes joka sivulle tulevan linkkikokoelman, jonka avulla voi siirtyä järjestelmän eri toimintoihin.
static void	printPageInfo(java.io.PrintWriter pw, java.lang.String userName, java.lang.String pageTitle) Tulostaa annettuun PrintWriteriin sivun otsikon ja tiedon millä tunnuksella ollaan kirjauduttu järjestelmään
static void	printTestingStuff(java.io.PrintWriter pw, HTTPRequest httpRequest) Testauksessa käytettävä metodi, joka tulostaa annettuun PrintWriteriin annetun HTTPRequestin mukana tulevat HTTP-parametrit ja keksit.
static java.lang.String	removeCookieHeader() Palauttaa HTTP-headerin joka poistaa selaimella (mahdollisesti) olevan session-id -cookien.
static java.lang.String	removeQuot(java.lang.String in) poistaa " ja ' -merkit.
static java.lang.String	removeSpace(java.lang.String in) Poistaa välilyönnit ja rivinvaihdot yms.
static java.lang.String	removeTag(java.lang.String in) Poistetaan < ja > -merkit
static java.lang.String	startPage(java.lang.String title) Palauttaa HTML-sivun alkuosan Stringinä.
static java.lang.String	startPage(java.lang.String title, java.lang.String redirect) Palauttaa HTML-sivun alkuosan Stringinä.

Methods inherited from class java.lang.Object

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

Method Detail

startPage

public static java.lang.String startPage(java.lang.String title)

Palauttaa HTML-sivun alkuosan Stringinä.

Parameters:

title - Sivun otsikko

startPage

public static java.lang.String startPage(java.lang.String title,
                                         java.lang.String redirect)

Palauttaa HTML-sivun alkuosan Stringinä. Tämän avulla voidaan tehdä uudelleenohjaus halutulle sivulle.

Parameters:

title - Sivun otsikko

redirect - Tiedoston nimi, johon tehdään uudelleenohjaus, esim. "Main"

printEndOfPage

public static void printEndOfPage(java.io.PrintWriter pw)

Tulostaa annettuun PrintWriteriin HTML-sivun lopun

Parameters:

pw - PrintWriter, johon tulostetaan

printPageInfo

public static void printPageInfo(java.io.PrintWriter pw,
                                 java.lang.String userName,
                                 java.lang.String pageTitle)

Tulostaa annettuun PrintWriteriin sivun otsikon ja tiedon millä tunnuksella ollaan kirjauduttu järjestelmään

Parameters:

pw - PrintWriter, johon tulostetaan

cookieHeader

public static java.lang.String cookieHeader(long sessionId)

Palauttaa HTTP-headerin joka lähettää selaimelle cookiena parametrina saatavan session-ID:n

Parameters:

sessionId - cookien sisällöksi tuleva session-id

removeCookieHeader

public static java.lang.String removeCookieHeader()

Palauttaa HTTP-headerin joka poistaa selaimella (mahdollisesti) olevan session-id -cookien. (Tämä tapahtuu siten, että cookien vanhentumisaika asetetaan menneisyyteen.)

[Set-Cookie: name=deleted; expires=Thu, 01-Jan-1970 00:00:00 GMT;]

printHeader

public static java.lang.String printHeader(java.lang.String contentType,
                                           long length,
                                           java.lang.String fileName)

Palauttaa HTTP-protokollan mukaiset WWW-palvelimen otsikkotiedot liitetiedostojen lähetystä varten.

Parameters:

contentType - lähetettävän tiedoston tyyppi, esim. "image/jpeg"

length - lähetettävän tiedoston koko

fileName - tiedostonimi

Returns:

HTTP-otsikkotiedot

printHeader

public static java.lang.String printHeader(java.lang.String contentType,
                                           java.lang.String fileName)

Palauttaa HTTP-protokollan mukaiset WWW-palvelimen otsikkotiedot liitetiedostojen lähetystä varten.

Parameters:

contentType - lähetettävän tiedoston tyyppi, esim. "image/jpeg"

fileName - tiedostonimi

Returns:

HTTP-otsikkotiedot

printNavigationBar

public static void printNavigationBar(java.io.PrintWriter pw)

Tulostaa annettuu PrintWriteriin käyttöliittymän "navigaatiopalkin", eli lähes joka sivulle tulevan linkkikokoelman, jonka avulla voi siirtyä järjestelmän eri toimintoihin.

Parannusidea: Parametrina voitaisiin saada se sivu jolla nyt ollaan. olisi ehkä käytettävyyden kannalta hyvä ratkaisu tulostaa se esim. eri värillä... [ class='current' ja css-tiedostoon vastaava sääntö. ]

Parameters:

pw - PrintWriter, johon tulostetaan

printEmergencyExitPage

public static void printEmergencyExitPage(java.io.PrintWriter pw)

Palauttaa selaimelle sivun joka uudelleenohjautuu Login-sivulle ja poistaa samalla session-id -keksin. Tätä voi kutsua jos viite user-olioon on null sellaisilla sivuilla joilla aina tarvitaan validi User-olio.

Parameters:

pw - PrintWriter, johon tulostetaan

printTestingStuff

public static void printTestingStuff(java.io.PrintWriter pw,
                                     HTTPRequest httpRequest)

Testauksessa käytettävä metodi, joka tulostaa annettuun PrintWriteriin annetun HTTPRequestin mukana tulevat HTTP-parametrit ja keksit.

Parameters:

pw - PrintWriter, johon tulostetaan

httpRequest - HTTP-pyyntö josta saadaan tulostettavat parametrit ja keksit

convertTag2Entity

public static java.lang.String convertTag2Entity(java.lang.String in)

Muuttaa < ja > -merkit &lt; ja &gt; -merkeiksi

removeTag

public static java.lang.String removeTag(java.lang.String in)

Poistetaan < ja > -merkit

removeQuot

public static java.lang.String removeQuot(java.lang.String in)

poistaa " ja ' -merkit.

normalize

public static java.lang.String normalize(java.lang.String in)

Kutsutaan removeTag, removeQuot ja removeSpace -metodeja.

removeSpace

public static java.lang.String removeSpace(java.lang.String in)

Poistaa välilyönnit ja rivinvaihdot yms.

convertSpace

public static java.lang.String convertSpace(java.lang.String in)

Muuttaa välilyönnit ja rivinvaihdot yms. alaviivoiksi

main

public static void main(java.lang.String[] args)

Pääohjelmametodi testausta varten.