Package org.compiere.util

Class WebDoc

java.lang.Object

org.compiere.util.WebDoc

public class WebDoc
extends Object

XHTML Document. Use to create html help content.

Version:

$Id: WebDoc.java,v 1.2 2006/07/30 00:51:05 jjanke Exp $

Author:

Jorg Janke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NBSP	Non breaking Space

Method Summary

Modifier and Type	Method	Description
org.apache.ecs.xhtml.td	addPopupCenter(boolean nowrap)	Add Popup Center
org.apache.ecs.xhtml.td[]	addPopupClose(Properties ctx)	Deprecated, for removal: This API element is subject to removal in a future version.
org.apache.ecs.xhtml.td	addWindowCenter(boolean nowrap)	Deprecated, for removal: This API element is subject to removal in a future version.
org.apache.ecs.xhtml.td	addWindowFooter()	Deprecated, for removal: This API element is subject to removal in a future version.
org.apache.ecs.xhtml.td[]	addWindowFooters()	Deprecated, for removal: This API element is subject to removal in a future version.
static WebDoc	create(boolean plain)	Create Document
static WebDoc	create(boolean plain, String title, boolean javaClient)	Create styled Document with Title
static WebDoc	create(String title)	Create styled web Document with Title
static WebDoc	createPopup(String title)	Deprecated, for removal: This API element is subject to removal in a future version.
static WebDoc	createWindow(String title)	Deprecated, for removal: This API element is subject to removal in a future version.
org.apache.ecs.xhtml.body	getBody()	Get Body
org.apache.ecs.xhtml.head	getHead()	Get Head
org.apache.ecs.xhtml.table	getTable()	Get Table (no class set)
org.apache.ecs.xhtml.td	getTopLeft()	Get Table Data Left (no class set)
org.apache.ecs.xhtml.td	getTopRight()	Get Table Data Right (no class set)
org.apache.ecs.xhtml.tr	getTopRow()	Get Table Row (no class set)
void	output(OutputStream out)	Output Document
void	output(PrintWriter out)	Output Document
void	setClasses(String tableClass, String tdClass)	Set css Classes
String	toString()	String representation

Methods inherited from class java.lang.Object

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

Field Details

NBSP

public static final String NBSP

Non breaking Space

See Also:

• Constant Field Values

Method Details

create

public static WebDoc create(boolean plain,
 String title,
 boolean javaClient)

Create styled Document with Title

Parameters:

plain - if true adds standard.css and standard.js

title - optional header title and h1

javaClient - true if Java Client - browser otherwise

Returns:

Document

create

public static WebDoc create(boolean plain)

Create Document

Parameters:

plain - if true adds stylesheet and standard js

Returns:

Document

createPopup

@Deprecated(since="13",
            forRemoval=true)
public static WebDoc createPopup(String title)

Deprecated, for removal: This API element is subject to removal in a future version.

Create styled popup Document with Title

Parameters:

title - header title and h1

Returns:

Document

createWindow

@Deprecated(since="13",
            forRemoval=true)
public static WebDoc createWindow(String title)

Deprecated, for removal: This API element is subject to removal in a future version.

Create styled window Document with Title

Parameters:

title - header title and h1

Returns:

Document

create

public static WebDoc create(String title)

Create styled web Document with Title

Parameters:

title - optional header title and h1

Returns:

Document

setClasses

public void setClasses(String tableClass,
 String tdClass)

Set css Classes

Parameters:

tableClass - optional class for table

tdClass - optional class for left/right td

getBody

public org.apache.ecs.xhtml.body getBody()

Get Body

Returns:

Body

getHead

public org.apache.ecs.xhtml.head getHead()

Get Head

Returns:

Header

getTable

public org.apache.ecs.xhtml.table getTable()

Get Table (no class set)

Returns:

table

getTopRow

public org.apache.ecs.xhtml.tr getTopRow()

Get Table Row (no class set)

Returns:

table row

getTopLeft

public org.apache.ecs.xhtml.td getTopLeft()

Get Table Data Left (no class set)

Returns:

table data

getTopRight

public org.apache.ecs.xhtml.td getTopRight()

Get Table Data Right (no class set)

Returns:

table data

toString

public String toString()

String representation

Overrides:

toString in class Object

Returns:

String

output

public void output(OutputStream out)

Output Document

Parameters:

out -

output

public void output(PrintWriter out)

Output Document

Parameters:

out -

addPopupCenter

public org.apache.ecs.xhtml.td addPopupCenter(boolean nowrap)

Add Popup Center

Parameters:

nowrap - set nowrap in td

Returns:

null or center single td

addPopupClose

@Deprecated(since="13",
            forRemoval=true)
@GeneratedCodeCoverageExclusion
public org.apache.ecs.xhtml.td[] addPopupClose(Properties ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Add Popup Close Footer

Returns:

null or array with left/right td

addWindowCenter

@Deprecated(since="13",
            forRemoval=true)
public org.apache.ecs.xhtml.td addWindowCenter(boolean nowrap)

Deprecated, for removal: This API element is subject to removal in a future version.

Add Window Center

Parameters:

nowrap - set no wrap in td

Returns:

empty single center td

addWindowFooters

@Deprecated(since="13",
            forRemoval=true)
public org.apache.ecs.xhtml.td[] addWindowFooters()

Deprecated, for removal: This API element is subject to removal in a future version.

Add Window Footer

Returns:

null or array with empty left/right td

addWindowFooter

@Deprecated(since="13",
            forRemoval=true)
public org.apache.ecs.xhtml.td addWindowFooter()

Deprecated, for removal: This API element is subject to removal in a future version.

Add Window Footer

Returns:

empty single center td