type

WebOutStream

@Js
class WebOutStream : OutStream

WebOutStream provides methods for generating XML and XHTML content.

constructors

make

Construct a WebOutStream that wraps the given OutStream.

methods

a

Start a <a> tag.

aEnd

End a <a> tag.

article

Start a <article> tag.

articleEnd

End a <article> tag.

aside

Start a <aside> tag.

asideEnd

End a <aside> tag.

atom

Write a complete <link> tag for an Atom feed resource.

b

Start a <b> tag.

bEnd

End a <b> tag.

body

Start a <body> tag.

bodyEnd

End a <body> tag.

br

Write out a complete <br/> tag.

button

Convenience for input("type='button'" + attrs).

checkbox

Convenience for input("type='checkbox'" + attrs)

code

Start a <code> tag.

codeEnd

End a <code> tag.

dd

Start a <dd> tag.

ddEnd

End a <dd> tag.

div

Start a <div> tag.

divEnd

End a <div> tag.

dl

Start a <dl> tag.

dlEnd

End a <dl> tag.

docType

Write the XHTML Strict DOCTYPE.

docType5

Write the HTML5 DOCTYPE.

dt

Start a <dt> tag.

dtEnd

End a <dt> tag.

em

Start a <em> tag.

emEnd

End a <em> tag.

esc

Write obj.toStr to the stream as valid XML text.

favIcon

Write a complete <link> tag for a favicon.

footer

Start a <footer> tag.

footerEnd

End a <footer> tag.

form

Start a <form> tag.

formEnd

End a <form> tag.

h1

Start a <h1> tag.

h1End

End a <h1> tag.

h2

Start a <h2> tag.

h2End

End a <h2> tag.

h3

Start a <h3> tag.

h3End

End a <h3> tag.

h4

Start a <h4> tag.

h4End

End a <h4> tag.

h5

Start a <h5> tag.

h5End

End a <h5> tag.

h6

Start a <h6> tag.

h6End

End a <h6> tag.

head

Start a <head> tag.

headEnd

End a <head> tag.

header

Start a <header> tag.

headerEnd

End a <header> tag.

hidden

Convenience for input("type='hidden'" + attrs).

hr

Write out a complete <hr/> tag.

html

Start a <html> tag.

htmlEnd

End a <html> tag.

i

Start a <i> tag.

iEnd

End a <i> tag.

img

Write a complete <img> tag.

includeCss

Write a complete <link> tag for an external CSS stylesheet.

includeJs

Write a complete <script> tag for an external JavaScript file.

initJs

Customize how the JavaScript runtime environment is initialized.

input

Write a complete <input> tag.

label

Start a <label> tag.

labelEnd

End a <label> tag.

li

Start a <li> tag.

liEnd

End a <li> tag.

main

Start a <main> tag.

mainEnd

End a <main> tag.

nav

Start a <nav> tag.

navEnd

End a <nav> tag.

nl

Convenience for writeChar(\n).

ol

Start a <ol> tag.

olEnd

End a <ol> tag.

option

Start a <option> tag.

optionEnd

End a <option> tag.

p

Start a <p> tag.

pEnd

End a <p> tag.

password

Convenience for input("type='password'" + attrs).

pre

Start a <pre> tag.

preEnd

End a <pre> tag.

prolog

Write out a prolog statement using the streams current charset encoding.

radio

Convenience for input("type='radio'" + attrs)

rss

Write a complete <link> tag for a RSS feed resource.

script

Start a <script> tag.

scriptEnd

End a <script> tag.

section

Start a <section> tag.

sectionEnd

End a <section> tag.

select

Start a <select> tag.

selectEnd

End a <select> tag.

span

Start a <span> tag.

spanEnd

End a <span> tag.

style

Start a <style> tag.

styleEnd

End a <style> tag.

submit

Convenience for input("type='submit'" + attrs).

tab

Convenience for writeChars(Str.spaces(numSpaces)).

table

Start a <table> tag.

tableEnd

End a <table> tag.

tag

Write a start tag.

tagEnd

Write an end tag.

tbody

Start a <tbody> tag.

tbodyEnd

End a <tbody> tag.

td

Start a <td> tag.

tdEnd

End a <td> tag.

textArea

Start a <textarea> tag.

textAreaEnd

End a <textarea> tag.

textField

Convenience for input("type='text'" + attrs).

tfoot

Start a <tfoot> tag.

tfootEnd

End a <tfoot> tag.

th

Start a <th> tag.

thEnd

End a <th> tag.

thead

Start a <thead> tag.

theadEnd

End a <thead> tag.

title

Write a complete <title> tag.

titleEnd

End a <title> tag.

tr

Start a <tr> tag.

trEnd

End a <tr> tag.

ul

Start a <ul> tag.

ulEnd

End a <ul> tag.

w

Convenience for writeChars(obj.toStr).

Slot Details

a

This a(Uri href, Str? attrs := null)

Start a <a> tag.

aEnd

This aEnd()

End a <a> tag.

article

This article(Str? attrs := null)

Start a <article> tag.

articleEnd

This articleEnd()

End a <article> tag.

aside

This aside(Str? attrs := null)

Start a <aside> tag.

asideEnd

This asideEnd()

End a <aside> tag.

atom

This atom(Uri href, Str? attrs := null)

Write a complete <link> tag for an Atom feed resource.

b

This b(Str? attrs := null)

Start a <b> tag.

bEnd

This bEnd()

End a <b> tag.

body

This body(Str? attrs := null)

Start a <body> tag.

bodyEnd

This bodyEnd()

End a <body> tag.

br

This br()

Write out a complete <br/> tag.

button

This button(Str? attrs := null)

Convenience for input("type='button'" + attrs).

checkbox

This checkbox(Str? attrs := null)

Convenience for input("type='checkbox'" + attrs)

code

This code(Str? attrs := null)

Start a <code> tag.

codeEnd

This codeEnd()

End a <code> tag.

dd

This dd(Str? attrs := null)

Start a <dd> tag.

ddEnd

This ddEnd()

End a <dd> tag.

div

This div(Str? attrs := null)

Start a <div> tag.

divEnd

This divEnd()

End a <div> tag.

dl

This dl(Str? attrs := null)

Start a <dl> tag.

dlEnd

This dlEnd()

End a <dl> tag.

docType

This docType()

Write the XHTML Strict DOCTYPE.

docType5

This docType5()

Write the HTML5 DOCTYPE.

dt

This dt(Str? attrs := null)

Start a <dt> tag.

dtEnd

This dtEnd()

End a <dt> tag.

em

This em(Str? attrs := null)

Start a <em> tag.

emEnd

This emEnd()

End a <em> tag.

esc

This esc(Obj? obj)

Write obj.toStr to the stream as valid XML text. The special control characters amp, lt, apos and quot are always escaped. The gt char is escaped only if it is the first char or if preceeded by the ] char. Also see Str.toXml. If obj is null, then "null" is written.

favIcon

This favIcon(Uri href, Str? attrs := null)

Write a complete <link> tag for a favicon. You must specifiy the MIME type for your icon in the attrs argument:

out.favIcon(`/fav.png`, "type='image/png'")

This footer(Str? attrs := null)

Start a <footer> tag.

footerEnd

This footerEnd()

End a <footer> tag.

form

This form(Str? attrs := null)

Start a <form> tag.

formEnd

This formEnd()

End a <form> tag.

h1

This h1(Str? attrs := null)

Start a <h1> tag.

h1End

This h1End()

End a <h1> tag.

h2

This h2(Str? attrs := null)

Start a <h2> tag.

h2End

This h2End()

End a <h2> tag.

h3

This h3(Str? attrs := null)

Start a <h3> tag.

h3End

This h3End()

End a <h3> tag.

h4

This h4(Str? attrs := null)

Start a <h4> tag.

h4End

This h4End()

End a <h4> tag.

h5

This h5(Str? attrs := null)

Start a <h5> tag.

h5End

This h5End()

End a <h5> tag.

h6

This h6(Str? attrs := null)

Start a <h6> tag.

h6End

This h6End()

End a <h6> tag.

This head()

Start a <head> tag.

headEnd

This headEnd()

End a <head> tag.

This header(Str? attrs := null)

Start a <header> tag.

headerEnd

This headerEnd()

End a <header> tag.

hidden

This hidden(Str? attrs := null)

Convenience for input("type='hidden'" + attrs).

hr

This hr(Str? attrs := null)

Write out a complete <hr/> tag.

html

This html()

Start a <html> tag.

htmlEnd

This htmlEnd()

End a <html> tag.

i

This i(Str? attrs := null)

Start a <i> tag.

iEnd

This iEnd()

End a <i> tag.

img

This img(Uri src, Str? attrs := null)

Write a complete <img> tag.

includeCss

This includeCss(Uri href)

Write a complete <link> tag for an external CSS stylesheet. If this URI has already been included in this WebOutStream instance, then this method does nothing.

includeJs

This includeJs(Uri? href := null)

Write a complete <script> tag for an external JavaScript file. If this URI has already been included in this WebOutStream instance, then this method does nothing.

initJs

This initJs(Str:Str env)

Customize how the JavaScript runtime environment is initialized. This method must be called inside the <head> tag, and also before sys.js is loaded in order to take effect.

Note this method is not necessary if no customization is needed. The JS runtime will automatically initialize using default values.

The following variables are supported:

  • timezone: set the default TimeZone for JsVM
  • locale: set the default Locale for the JsVM. Note you must manually provide the locale config.props files. See FilePack.toLocaleJsFile.
  • main: an optional method to invoke after the page has been loaded. The main argument can be either a type or method. If no method is specified, main is used. If the method is not static, a new instance of type is created:
    "foo::Instance"     =>  Instance().main()
    "foo::Instance.bar" =>  Instance().bar()
    "foo::Static"       =>  Static.main()
    "foo::Static.bar"   =>  Static.bar()

input

This input(Str? attrs := null)

Write a complete <input> tag.

label

This label(Str? attrs := null)

Start a <label> tag.

labelEnd

This labelEnd()

End a <label> tag.

li

This li(Str? attrs := null)

Start a <li> tag.

liEnd

This liEnd()

End a <li> tag.

main

This main(Str? attrs := null)

Start a <main> tag.

mainEnd

This mainEnd()

End a <main> tag.

make

new make(OutStream out)

Construct a WebOutStream that wraps the given OutStream.

This nav(Str? attrs := null)

Start a <nav> tag.

This navEnd()

End a <nav> tag.

nl

This nl()

Convenience for writeChar(\n).

ol

This ol(Str? attrs := null)

Start a <ol> tag.

olEnd

This olEnd()

End a <ol> tag.

option

This option(Str? attrs := null)

Start a <option> tag.

optionEnd

This optionEnd()

End a <option> tag.

p

This p(Str? attrs := null)

Start a <p> tag.

pEnd

This pEnd()

End a <p> tag.

password

This password(Str? attrs := null)

Convenience for input("type='password'" + attrs).

pre

This pre(Str? attrs := null)

Start a <pre> tag.

preEnd

This preEnd()

End a <pre> tag.

prolog

This prolog()

Write out a prolog statement using the streams current charset encoding.

radio

This radio(Str? attrs := null)

Convenience for input("type='radio'" + attrs)

rss

This rss(Uri href, Str? attrs := null)

Write a complete <link> tag for a RSS feed resource.

script

This script(Str? attrs := "type='text/javascript'")

Start a <script> tag.

scriptEnd

This scriptEnd()

End a <script> tag.

section

This section(Str? attrs := null)

Start a <section> tag.

sectionEnd

This sectionEnd()

End a <section> tag.

select

This select(Str? attrs := null)

Start a <select> tag.

selectEnd

This selectEnd()

End a <select> tag.

span

This span(Str? attrs := null)

Start a <span> tag.

spanEnd

This spanEnd()

End a <span> tag.

style

This style(Str? attrs := "type='text/css'")

Start a <style> tag.

styleEnd

This styleEnd()

End a <style> tag.

submit

This submit(Str? attrs := null)

Convenience for input("type='submit'" + attrs).

tab

This tab(Int numSpaces := 2)

Convenience for writeChars(Str.spaces(numSpaces)).

table

This table(Str? attrs := null)

Start a <table> tag.

tableEnd

This tableEnd()

End a <table> tag.

tag

This tag(Str elemName, Str? attrs := null, Bool empty := false)

Write a start tag. Use attrs to fully specify the attributes manually. Use empty to optionally close this element without using an end tag.

tagEnd

This tagEnd(Str elemName)

Write an end tag.

tbody

This tbody(Str? attrs := null)

Start a <tbody> tag.

tbodyEnd

This tbodyEnd()

End a <tbody> tag.

td

This td(Str? attrs := null)

Start a <td> tag.

tdEnd

This tdEnd()

End a <td> tag.

textArea

This textArea(Str? attrs := null)

Start a <textarea> tag.

textAreaEnd

This textAreaEnd()

End a <textarea> tag.

textField

This textField(Str? attrs := null)

Convenience for input("type='text'" + attrs).

tfoot

This tfoot(Str? attrs := null)

Start a <tfoot> tag.

tfootEnd

This tfootEnd()

End a <tfoot> tag.

th

This th(Str? attrs := null)

Start a <th> tag.

thEnd

This thEnd()

End a <th> tag.

thead

This thead(Str? attrs := null)

Start a <thead> tag.

theadEnd

This theadEnd()

End a <thead> tag.

title

This title(Str? attrs := null)

Write a complete <title> tag.

titleEnd

This titleEnd()

End a <title> tag.

tr

This tr(Str? attrs := null)

Start a <tr> tag.

trEnd

This trEnd()

End a <tr> tag.

ul

This ul(Str? attrs := null)

Start a <ul> tag.

ulEnd

This ulEnd()

End a <ul> tag.

w

This w(Obj? obj)

Convenience for writeChars(obj.toStr).