Class WebOutStream

WebOutStream provides methods for generating XML and XHTML content.

Hierarchy (View Summary)

OutStream
- WebOutStream
  - DocOutStream

Index

Constructors

constructor

new WebOutStream(): WebOutStream
Returns WebOutStream
Inherited from OutStream.constructor

Properties

`Static`type$

type$: Type

Methods

a

a(href: Uri, attrs?: string): this
Start a tag.
Parameters
- href: Uri
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:971

aEnd

aEnd(): this
End a tag.

Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1127

article

article(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1177

articleEnd

articleEnd(): this
End a
tag.

Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1269

aside

aside(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1181

asideEnd

asideEnd(): this
End a
tag.

Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:885

atom

atom(href: Uri, attrs?: string): this
Write a complete tag for an Atom feed resource.
Parameters
- href: Uri
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1031

b

b(attrs?: string): this
Start a tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:975

bEnd

bEnd(): this
End a tag.

Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:923

body

body(attrs?: string): this
Start a tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1095

bodyEnd

bodyEnd(): this
End a tag.

Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1153

br

br(): this
Write out a complete
tag.

Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:939

button

button(attrs?: string): this
Convenience for input("type='button'" + attrs).
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1265

charset

charset(): Charset
The current charset used to encode Unicode characters into bytes. The default charset should always be UTF-8.

Returns Charset
Inherited from OutStream.charset
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9294
charset(it: Charset): void
The current charset used to encode Unicode characters into bytes. The default charset should always be UTF-8.
Parameters
- it: Charset
Returns void
Inherited from OutStream.charset
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9295

checkbox

checkbox(attrs?: string): this
Convenience for input("type='checkbox'" + attrs)
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:959

close

close(): boolean
Close the output stream. This method is guaranteed to never throw an IOErr. Return true if the stream was closed successfully or false if the stream was closed abnormally. Default implementation does nothing and returns true.

Returns boolean
Inherited from OutStream.close
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9376

code

code(attrs?: string): this
Start a tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1213

`codeEnd`

codeEnd(): this
End a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1099

`compare`

compare(that: JsObj): number
Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:
this < that => <0 this == that => 0 this > that => >0 This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang. Examples: 3.compare(8) => -1 8.compare(3) => 1 8.compare(8) => 0 3 <=> 8 => -1 // shortcut for 3.compare(8)
Parameters
- that: JsObj
Returns number
Inherited from OutStream.compare
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9196

`dd`

dd(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1059

`ddEnd`

ddEnd(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1123

`div`

div(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1111

`divEnd`

divEnd(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:907

`dl`

dl(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1079

`dlEnd`

dlEnd(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1055

`docType`

docType(): this
Write the XHTML Strict DOCTYPE.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:979

`docType5`

docType5(): this
Write the HTML5 DOCTYPE.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1007

`dt`

dt(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1115

`dtEnd`

dtEnd(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1157

`em`

em(attrs?: string): this
Start a tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1165

`emEnd`

emEnd(): this
End a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1273

`endian`

endian(): Endian
Byte order mode for binary writes. Default is Endian.big (network byte order).
Returns Endian
Inherited from OutStream.endian
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9300
endian(it: Endian): void
Byte order mode for binary writes. Default is Endian.big (network byte order).
Parameters
- it: Endian
Returns void
Inherited from OutStream.endian
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9301

`equals`

equals(that: JsObj): boolean
Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.
Parameters
- that: JsObj
Returns boolean
Inherited from OutStream.equals
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9217

`esc`

esc(obj: JsObj): this
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 sys::Str.toXml. If obj is null, then "null" is written.
Parameters
- obj: JsObj
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1019

`favIcon`

favIcon(href: Uri, attrs?: string): this
Write a complete tag for a favicon. You must specifiy the MIME type for your icon in the attrs argument:
out.favIcon(`/fav.png`, "type='image/png'")
Parameters
- href: Uri
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1287

`flush`

flush(): this
Flush the stream so any buffered bytes are written out. Default implementation does nothing. Throw IOErr on error. Return this.
Returns this
Inherited from OutStream.flush
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9357

footer(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1225

`footerEnd`

footerEnd(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:915

`form`

form(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1340

`formEnd`

formEnd(): this
End a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1311

`h1`

h1(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1233

`h1End`

h1End(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1063

`h2`

h2(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1237

`h2End`

h2End(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:967

`h3`

h3(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1241

`h3End`

h3End(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1205

`h4`

h4(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1249

`h4End`

h4End(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1193

`h5`

h5(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1253

`h5End`

h5End(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:889

`h6`

h6(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1257

`h6End`

h6End(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1352

`hash`

hash(): number
Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.
Returns number
Inherited from OutStream.hash
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9263

`head`

head(): this
Start a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1261

`headEnd`

headEnd(): this
End a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1189

header(attrs?: string): this
Start a
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1185

`headerEnd`

headerEnd(): this
End a
tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:935

`hidden`

hidden(attrs?: string): this
Convenience for input("type='hidden'" + attrs).
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1217

`hr`

hr(attrs?: string): this
Write out a complete
tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:847

`html`

html(): this
Start a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1139

`htmlEnd`

htmlEnd(): this
End a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1149

`i`

i(attrs?: string): this
Start a tag.
Parameters
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:987

`iEnd`

iEnd(): this
End a tag.
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1067

`img`

img(src: Uri, attrs?: string): this
Write a complete tag.
Parameters
- src: Uri
- Optionalattrs: string
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:1209

`includeCss`

includeCss(href: Uri): this
Write a complete tag for an external CSS stylesheet. If this URI has already been included in this WebOutStream instance, then this method does nothing.
Parameters
- href: Uri
Returns this
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/web.d.ts:903

`includeJs`

includeJs(href?: Uri): this
Write a complete

Class WebOutStream

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns WebOutStream

Properties

Statictype$

Methods

a

Parameters

Returns this

aEnd

Returns this

article

Parameters

Returns this

articleEnd

Returns this

aside

Parameters

Returns this

asideEnd

Returns this

atom

Parameters

Returns this

b

Parameters

Returns this

bEnd

Returns this

body

Parameters

Returns this

bodyEnd

Returns this

br

Returns this

button

Parameters

Returns this

charset

Returns Charset

Parameters

Returns void

checkbox

Parameters

Returns this

close

Returns boolean

code

Parameters

Returns this

codeEnd

Returns this

compare

Parameters

Returns number

dd

Parameters

Returns this

ddEnd

Returns this

div

Parameters

Returns this

divEnd

Returns this

dl

Parameters

Returns this

dlEnd

Returns this

docType

Returns this

docType5

`Static`type$

`Parameters`

`Returns this`

`codeEnd`

`Returns this`

`compare`

`Parameters`

`Returns number`

`dd`

`Parameters`

`Returns this`

`ddEnd`

`Returns this`

`div`

`Parameters`

`Returns this`

`divEnd`

`Returns this`

`dl`

`Parameters`

`Returns this`

`dlEnd`

`Returns this`

`docType`

`Returns this`

`docType5`

`Returns this`

`dt`

`Parameters`

`Returns this`

`dtEnd`

`Returns this`

`em`

`Parameters`

`Returns this`

`emEnd`

`Returns this`

`endian`

`Returns Endian`

`Parameters`

`Returns void`

`equals`

`Parameters`

`Returns boolean`

`esc`

`Parameters`

`Returns this`

`favIcon`

`Parameters`

`Returns this`

`flush`

`Returns this`

`footer`

`Parameters`

`Returns this`

`footerEnd`

`Returns this`

`form`

`Parameters`

`Returns this`

`formEnd`

`Returns this`

`h1`

`tag.`

`Parameters`

`Returns this`

`h1End`

`tag.`

`Returns this`

`h2`

`tag.`

`Parameters`

`Returns this`

`h2End`

`tag.`

`Returns this`

`h3`

`tag.`

`Parameters`

`Returns this`