org.opentox.toxotis.core.html
Interface HTMLHead

All Known Implementing Classes:
HTMLHeadImpl

public interface HTMLHead

Header of an HTML document.

Author:
Pantelis Sopasakis, Charalampos Chomenides

Method Summary
 String getAuthor()
          Getter method for the authtor(s) of the current HTML document
 URL getCssUrl()
          Returns the URL of the CSS document related to the current HTML document.
 String getTitle()
          Getter method for the title of the HTML document.
 HTMLHead setAuthor(String author)
          Specify the author(s) of the current HTML document.
 HTMLHead setCssUrl(URL url)
          Set the URL where a CSS document can be found thus defining the style of the HTML document.
 HTMLHead setDoRedirect(URL url)
          If this page is a redirection to another URI, set the URL to redirect to.
 HTMLHead setDoRefresh(boolean doRegresh, int secondsDelay)
          Set a refresh rate for the HTML page.
 HTMLHead setTitle(String title)
          Setter for the title of the HTML document, which is inccluded in the <head> section of the document.
 

Method Detail

setCssUrl

HTMLHead setCssUrl(URL url)
Set the URL where a CSS document can be found thus defining the style of the HTML document. The CSS document has to be online for the HTML document to access it.

Parameters:
url - URL of the CSS document.
Returns:
The current modifiable HTMLHead object.

getCssUrl

URL getCssUrl()
Returns the URL of the CSS document related to the current HTML document.

Returns:
URL of CSS document or null if not any.

setDoRefresh

HTMLHead setDoRefresh(boolean doRegresh,
                      int secondsDelay)
Set a refresh rate for the HTML page. The HTML document, through the browser, will refresh itseld every some time.

Parameters:
doRegresh - Whether the page should refresh itself.
secondsDelay - Delay between successive refreshes.
Returns:
The current modifiable HTMLHead object.

setDoRedirect

HTMLHead setDoRedirect(URL url)
If this page is a redirection to another URI, set the URL to redirect to. If null, no redirection will happen.

Parameters:
url - The URL to redirect to.
Returns:
The current modifiable HTMLHead object.

setTitle

HTMLHead setTitle(String title)
Setter for the title of the HTML document, which is inccluded in the <head> section of the document.

Parameters:
title - The title of the HTML document.
Returns:
The current modifiable HTMLHead object.

getTitle

String getTitle()
Getter method for the title of the HTML document.

Returns:
The title of the current HTMLHead object.

setAuthor

HTMLHead setAuthor(String author)
Specify the author(s) of the current HTML document.

Parameters:
author - Author of HTML document.
Returns:
The current modifiable HTMLHead object.

getAuthor

String getAuthor()
Getter method for the authtor(s) of the current HTML document

Returns:
The author(s) of this HTML document, as specified in the header.


Copyright © 2011-2012 OpenTox. All Rights Reserved.