pt.digitalis.dif.presentation.views.jsp.objects.contributions
Class DocumentContributions

java.lang.Object
  pt.digitalis.dif.presentation.views.jsp.objects.contributions.DocumentContributions

public class DocumentContributions
extends java.lang.Object

Manages the contributions for a given HTML page. Will collect all from all the inner tags and render them in the end in a aggregated structured way

Author:

Pedro Viegas pviegas@digitalis.pt

Created on:

Dec 18, 2007

Field Summary

static java.lang.String

INDENT The indentation for css and js blocks.

Constructor Summary

DocumentContributions()

Method Summary

void	addContribution(IDocumentContribution contribution) Adds a new contributions to the corresponding unique/non-unique list.
void	addContributions(DocumentContributions contributions) Adds a set of contributions to the list.
void	addContributions(java.util.List<IDocumentContribution> list) Adds a list of contributions.
void	addCSS(java.lang.String CSSFileName) Adds a new CSS file as an unique contribution.
void	addCSS(java.lang.String CSSFileName, java.lang.String media) Adds a new CSS file as an unique contribution.
void	addCSSClassDefinition(java.lang.String CSSClass) Adds a new CSS class definition as an in-line CSS definition.
void	addJavaScript(java.lang.String javaScriptFileName) Adds a new JavaScript file as an unique contribution.
void	addJavaScriptCodeSnippet(java.lang.String javaScriptSnippet) Adds a new JavaScript snippet of code as a non-unique contribution.
java.lang.String	getFooterBlock() Gets the footer block.
java.lang.String	getFooterBlock(java.lang.Boolean applyMaskOnLoad) Gets the footer block.
java.lang.String	getHeaderBlock() Gets the header block.
java.lang.String	getHeaderScriptsBlock() Deprecated.
boolean	isEmpty() Checks if is empty.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

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

Field Detail

INDENT

public static final java.lang.String INDENT

The indentation for css and js blocks.

See Also:

Constant Field Values

Constructor Detail

DocumentContributions

public DocumentContributions()

Method Detail

addContribution

public void addContribution(IDocumentContribution contribution)

Adds a new contributions to the corresponding unique/non-unique list.

Parameters:

contribution - the contribution to add

addContributions

public void addContributions(DocumentContributions contributions)

Adds a set of contributions to the list.

Parameters:

contributions - the contributions to add

addContributions

public void addContributions(java.util.List<IDocumentContribution> list)

Adds a list of contributions.

Parameters:

list - of contributions to add

addCSS

public void addCSS(java.lang.String CSSFileName)

Adds a new CSS file as an unique contribution.

Parameters:

CSSFileName - the file to add

addCSS

public void addCSS(java.lang.String CSSFileName,
                   java.lang.String media)

Adds a new CSS file as an unique contribution.

Parameters:

CSSFileName - the file to add

media - the css media

addCSSClassDefinition

public void addCSSClassDefinition(java.lang.String CSSClass)

Adds a new CSS class definition as an in-line CSS definition.

Parameters:

CSSClass - the class to add

addJavaScript

public void addJavaScript(java.lang.String javaScriptFileName)

Adds a new JavaScript file as an unique contribution.

Parameters:

javaScriptFileName - the file to add

addJavaScriptCodeSnippet

public void addJavaScriptCodeSnippet(java.lang.String javaScriptSnippet)

Adds a new JavaScript snippet of code as a non-unique contribution.

Parameters:

javaScriptSnippet - the code to add

getFooterBlock

public java.lang.String getFooterBlock()

Gets the footer block.

Returns:

the contributions page end block for HTML page inclusion

getFooterBlock

public java.lang.String getFooterBlock(java.lang.Boolean applyMaskOnLoad)

Gets the footer block.

Parameters:

applyMaskOnLoad - Apply's to the page a mask when on load events area executing.

Returns:

the contributions page end block for HTML page inclusion

getHeaderBlock

public java.lang.String getHeaderBlock()

Gets the header block.

Returns:

a partial HEAD section for HTML page inclusion

getHeaderScriptsBlock

@Deprecated
public java.lang.String getHeaderScriptsBlock()

Deprecated.

Deprecated: Only used in DIF1.

Returns:

a partial HEAD script section for HTML page inclusion,

isEmpty

public boolean isEmpty()

Checks if is empty.

Returns:

T if there are no contributions

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

See Also:

Object.toString()