+
Point of view
All features
class HTML_OUTPUT_STREAM
Summary
top
Highly tailored filter that outputs well-formed HTML. Be aware that you cannot add any character as you want. You can filter this stream, but keep it available because it controls the tags.
Direct parents
Inherit list: FILTER_OUTPUT_STREAM
Class invariant
top
Overview
top
Creation features
{ANY}
Features
CGI extensions: written before the HTML itself is open
{ANY}
Main HTML structure
{ANY}
{ANY}
Attributes management
{ANY}
  • attributes: STRING
    Because there are so many attributes for each tag, we did not want features with scores of parameters.%
  • with_attribute (name: STRING, value: STRING)
    Call this feature before adding an opening tag; all the attributes will be added to the tag.
{HTML_HANDLER}
{FILTER_OUTPUT_STREAM}
Putting characters
{ANY}
{ANY}
Header tags
{ANY}
Frames
{ANY}
Body tags
{ANY}
Forms
{ANY}
{}
State queries
{ANY}
States
{}
Send to the underlying stream
{}
{}
{ANY}
{}
Once strings
{}
{ANY}
  • disconnect
    Disconnect from the underlying stream.
{STREAM}
  • do_detach
    Used by the underlying stream to require not to be filtered anymore
{}
{ANY}
{FILTER}
{ANY}
{}
{ANY}
{}
{STREAM_HANDLER}
{FILTER}
{ANY}
{}
{RECYCLING_POOL}
  • recycle
    Do whatever needs to be done to free resources or recycle other objects when recycling this one
{}
  • dispose
    Action to be executed just before garbage collection reclaims an object.
{}
{ANY}
{ABSTRACT_STRING}
{ANY}
To write a number:
{ANY}
Other features:
{ANY}
{}
{}
{FILTER}
put_cgi_header (key: STRING, value: STRING)
effective procedure
{ANY}
top
header
effective procedure
{ANY}
top
body
effective procedure
{ANY}
top
frames
effective procedure
{ANY}
top
close
effective procedure
{ANY}
top
last_tag: STRING
effective function
{ANY}
top
has_open_tag: BOOLEAN
effective function
{ANY}
top
attributes: STRING
writable attribute
{ANY}
top
Because there are so many attributes for each tag, we did not want features with scores of parameters.%
with_attribute (name: STRING, value: STRING)
effective procedure
{ANY}
top
Call this feature before adding an opening tag; all the attributes will be added to the tag.
open_tag (tag: STRING)
effective procedure
{HTML_HANDLER}
top
open_close_tag (tag: STRING)
effective procedure
{HTML_HANDLER}
top
close_tag (tag: STRING)
effective procedure
{HTML_HANDLER}
top
put_filtered_string (string: STRING)
effective procedure
{HTML_HANDLER}
top
filtered_put_character (c: CHARACTER)
effective procedure
{FILTER_OUTPUT_STREAM}
top
filtered_flush
effective procedure
{FILTER_OUTPUT_STREAM}
top
can_put_character (c: CHARACTER): BOOLEAN
effective function
{ANY}
top
put_entity (entity: STRING)
effective procedure
{ANY}
top
put_comment (comment: STRING)
effective procedure
{ANY}
top
indent
effective procedure
{ANY}
top
put_base (base: STRING)
effective procedure
{ANY}
top
put_meta (equiv: STRING, content: STRING)
effective procedure
{ANY}
top
put_stylesheet (ref: STRING)
effective procedure
{ANY}
top
put_javascript (ref: STRING)
effective procedure
{ANY}
top
open_title
effective procedure
{ANY}
top
close_title
effective procedure
{ANY}
top
put_script (language: STRING, source: STRING)
effective procedure
{ANY}
top
open_script (language: STRING)
effective procedure
{ANY}
top
close_script
effective procedure
{ANY}
top
open_frameset
effective procedure
{ANY}
top
close_frameset
effective procedure
{ANY}
top
put_frame (src: STRING, name: STRING)
effective procedure
{ANY}
top
open_noframes
effective procedure
{ANY}
top
close_noframes
effective procedure
{ANY}
top
open_section
effective procedure
{ANY}
top
close_section
effective procedure
{ANY}
top
open_subsection
effective procedure
{ANY}
top
close_subsection
effective procedure
{ANY}
top
open_subsubsection
effective procedure
{ANY}
top
close_subsubsection
effective procedure
{ANY}
top
put_break
effective procedure
{ANY}
top
put_horizontal_rule
effective procedure
{ANY}
top
put_image (source: STRING)
effective procedure
{ANY}
top
open_bold
effective procedure
{ANY}
top
close_bold
effective procedure
{ANY}
top
open_font (size: STRING)
effective procedure
{ANY}
top
close_font
effective procedure
{ANY}
top
open_italics
effective procedure
{ANY}
top
close_italics
effective procedure
{ANY}
top
open_underlined
effective procedure
{ANY}
top
close_underlined
effective procedure
{ANY}
top
open_typeset
effective procedure
{ANY}
top
close_typeset
effective procedure
{ANY}
top
open_anchor_address (ref: STRING, target: STRING)
effective procedure
{ANY}
top
open_anchor_name (ref: STRING)
effective procedure
{ANY}
top
open_anchor
effective procedure
{ANY}
top
close_anchor
effective procedure
{ANY}
top
open_list
effective procedure
{ANY}
top
open_numbered_list
effective procedure
{ANY}
top
close_list
effective procedure
{ANY}
top
open_definition_list
effective procedure
{ANY}
top
close_definition_list
effective procedure
{ANY}
top
open_definition_term
effective procedure
{ANY}
top
close_definition_term
effective procedure
{ANY}
top
open_definition_description
effective procedure
{ANY}
top
close_definition_description
effective procedure
{ANY}
top
open_list_item
effective procedure
{ANY}
top
close_list_item
effective procedure
{ANY}
top
open_table
effective procedure
{ANY}
top
close_table
effective procedure
{ANY}
top
open_table_row
effective procedure
{ANY}
top
close_table_row
effective procedure
{ANY}
top
open_table_cell
effective procedure
{ANY}
top
close_table_cell
effective procedure
{ANY}
top
open_form (name: STRING, method: STRING, action: STRING)
effective procedure
{ANY}
top
close_form
effective procedure
{ANY}
top
open_text_area (name: STRING, rows: INTEGER_32, cols: INTEGER_32)
effective procedure
{ANY}
top
close_text_area
effective procedure
{ANY}
top
put_button (name: STRING, title: STRING)
effective procedure
{ANY}
top
put_validate_button (name: STRING, title: STRING)
effective procedure
{ANY}
top
put_reset_button (name: STRING, title: STRING)
effective procedure
{ANY}
top
put_hidden_field (name: STRING, value: STRING)
effective procedure
{ANY}
top
put_text_field (name: STRING, value: STRING)
effective procedure
{ANY}
top
put_password_field (name: STRING, value: STRING)
effective procedure
{ANY}
top
put_radio_button (name: STRING, value: STRING, checked: BOOLEAN)
effective procedure
{ANY}
top
put_check_box (name: STRING, value: STRING, checked: BOOLEAN)
effective procedure
{ANY}
top
open_combo_select (name: STRING)
effective procedure
{ANY}
top
open_multiple_select (name: STRING, size: INTEGER_32)
effective procedure
{ANY}
top
close_select
effective procedure
{ANY}
top
open_option (value: STRING)
effective procedure
{ANY}
top
close_option
effective procedure
{ANY}
top
open_paragraph
effective procedure
{ANY}
top
close_paragraph
effective procedure
{ANY}
top
open_preformatted
effective procedure
{ANY}
top
close_preformatted
effective procedure
{ANY}
top
open_blockquote
effective procedure
{ANY}
top
close_blockquote
effective procedure
{ANY}
top
open_div
effective procedure
{ANY}
top
close_div
effective procedure
{ANY}
top
open_span
effective procedure
{ANY}
top
close_span
effective procedure
{ANY}
top
put_input (type: STRING, name: STRING, value: STRING, checked: BOOLEAN)
effective procedure
{}
top
started: BOOLEAN
effective function
{ANY}
top
finished: BOOLEAN
effective function
{ANY}
top
in_header: BOOLEAN
effective function
{ANY}
top
in_script: BOOLEAN
effective function
{ANY}
top
in_body: BOOLEAN
effective function
{ANY}
top
in_list: BOOLEAN
effective function
{ANY}
top
in_list_item: BOOLEAN
effective function
{ANY}
top
in_table: BOOLEAN
effective function
{ANY}
top
in_table_row: BOOLEAN
effective function
{ANY}
top
in_table_cell: BOOLEAN
effective function
{ANY}
top
in_form: BOOLEAN
effective function
{ANY}
top
in_select: BOOLEAN
effective function
{ANY}
top
in_option: BOOLEAN
effective function
{ANY}
top
in_frames: BOOLEAN
effective function
{ANY}
top
in_frameset: BOOLEAN
effective function
{ANY}
top
in_noframes: BOOLEAN
effective function
{ANY}
top
in_a_body: BOOLEAN
effective function
{ANY}
top
in_a_form: BOOLEAN
effective function
{ANY}
top
in_text_area: BOOLEAN
effective function
{ANY}
top
in_paragraph: BOOLEAN
effective function
{ANY}
top
in_blockquote: BOOLEAN
effective function
{ANY}
top
in_div: BOOLEAN
effective function
{ANY}
top
in_preformatted: BOOLEAN
effective function
{ANY}
top
in_span: BOOLEAN
effective function
{ANY}
top
in_definition_list: BOOLEAN
effective function
{ANY}
top
in_definition_description: BOOLEAN
effective function
{ANY}
top
in_definition_term: BOOLEAN
effective function
{ANY}
top
state: INTEGER_32
effective function
{}
top
set_state (a_state: INTEGER_32)
effective procedure
{}
top
reset_state (a_state: INTEGER_32)
effective procedure
{}
top
state_closed: INTEGER_32
is 0
constant attribute
{}
top
state_in_header: INTEGER_32
is 10
constant attribute
{}
top
state_in_script: INTEGER_32
is 11
constant attribute
{}
top
state_in_body: INTEGER_32
is 20
constant attribute
{}
top
state_in_list: INTEGER_32
is 21
constant attribute
{}
top
state_in_list_item: INTEGER_32
is 22
constant attribute
{}
top
state_in_table: INTEGER_32
is 23
constant attribute
{}
top
state_in_table_row: INTEGER_32
is 24
constant attribute
{}
top
state_in_table_cell: INTEGER_32
is 25
constant attribute
{}
top
state_in_text_area: INTEGER_32
is 26
constant attribute
{}
top
state_in_paragraph: INTEGER_32
is 27
constant attribute
{}
top
state_in_blockquote: INTEGER_32
is 28
constant attribute
{}
top
state_in_div: INTEGER_32
is 29
constant attribute
{}
top
state_in_pre: INTEGER_32
is 30
constant attribute
{}
top
state_in_form: INTEGER_32
is 40
constant attribute
{}
top
state_in_select: INTEGER_32
is 41
constant attribute
{}
top
state_in_option: INTEGER_32
is 42
constant attribute
{}
top
state_in_frames: INTEGER_32
is 50
constant attribute
{}
top
state_in_frameset: INTEGER_32
is 51
constant attribute
{}
top
state_in_noframes: INTEGER_32
is 52
constant attribute
{}
top
state_in_span: INTEGER_32
is 53
constant attribute
{}
top
state_in_definition_list: INTEGER_32
is 60
constant attribute
{}
top
state_in_definition_description: INTEGER_32
is 61
constant attribute
{}
top
state_in_definition_term: INTEGER_32
is 62
constant attribute
{}
top
state_over: INTEGER_32
is 99
constant attribute
{}
top
pipe_character (c: CHARACTER)
effective procedure
{}
top
Put the character down the pipe.
pipe_string (s: STRING)
effective procedure
{}
top
Put the whole string down the pipe.
pipe_quoted_string (quoted: STRING)
effective procedure
{}
top
quote_quotes (quoted: STRING, in: STRING)
effective procedure
{}
top
Internal transformation in tag attributes
make
effective procedure
{ANY}
top
connect_to (a_stream: OUTPUT_STREAM)
effective procedure
{ANY}
top
Connect the filter to some underlying stream.
local_can_disconnect: BOOLEAN
effective function
{}
top
True if this stream can be safely disconnected (without data loss, etc.)
writable attribute
{}
top
writable attribute
{}
top
has_cgi_header: BOOLEAN
writable attribute
{}
top
are there any CGI headers before the HTML itself is inserted?
last_character_is_new_line: BOOLEAN
writable attribute
{}
top
True if the last put character was a '%N'
os_key_colon: STRING
is ": "
constant attribute
{}
top
os_html_header: STRING
is "<!doctype html public "-//w3c//dtd xhtml 1.0 transitional//en" "dtd/xhtml1-transitional.dtd"> <html> <head> "
constant attribute
{}
top
os_html_body_start: STRING
is "</head> <body"
constant attribute
{}
top
os_html_body_footer: STRING
is "</body> </html> "
constant attribute
{}
top
os_html_frames_footer: STRING
is "</html> "
constant attribute
{}
top
os_start_comment: STRING
is "<!-- "
constant attribute
{}
top
os_end_comment: STRING
is " -->"
constant attribute
{}
top
os_entity_quot: STRING
is "&quot;"
constant attribute
{}
top
os_entity_lt: STRING
is "&lt;"
constant attribute
{}
top
os_entity_gt: STRING
is "&gt;"
constant attribute
{}
top
os_entity_amp: STRING
is "&amp;"
constant attribute
{}
top
os_base: STRING
is "<base href='"
constant attribute
{}
top
os_end_open_close_tag_attrib: STRING
is "'/>"
constant attribute
{}
top
os_meta_equiv: STRING
is "<meta http-equiv='"
constant attribute
{}
top
os_attrib_content: STRING
is "' content='"
constant attribute
{}
top
os_attrib_type: STRING
is "' type='"
constant attribute
{}
top
os_stylesheet: STRING
is "<link rel='StyleSheet' type='text/css' href='"
constant attribute
{}
top
os_text_javascript: STRING
is "text/javascript"
constant attribute
{}
top
os_title: STRING
is "title"
constant attribute
{}
top
os_script_begin: STRING
is "<script language='"
constant attribute
{}
top
os_attrib_src: STRING
is "' src='"
constant attribute
{}
top
os_script_end: STRING
is "'></script>"
constant attribute
{}
top
os_language: STRING
is "language"
constant attribute
{}
top
os_javascript: STRING
is "javascript"
constant attribute
{}
top
os_script: STRING
is "script"
constant attribute
{}
top
os_h1: STRING
is "h1"
constant attribute
{}
top
os_h2: STRING
is "h2"
constant attribute
{}
top
os_h3: STRING
is "h3"
constant attribute
{}
top
os_br: STRING
is "br"
constant attribute
{}
top
os_hr: STRING
is "hr"
constant attribute
{}
top
os_img: STRING
is "img"
constant attribute
{}
top
os_src: STRING
is "src"
constant attribute
{}
top
os_b: STRING
is "b"
constant attribute
{}
top
os_i: STRING
is "i"
constant attribute
{}
top
os_u: STRING
is "u"
constant attribute
{}
top
os_tt: STRING
is "tt"
constant attribute
{}
top
os_size: STRING
is "size"
constant attribute
{}
top
os_font: STRING
is "font"
constant attribute
{}
top
os_pre: STRING
is "pre"
constant attribute
{}
top
os_href: STRING
is "href"
constant attribute
{}
top
os_target: STRING
is "target"
constant attribute
{}
top
os_name: STRING
is "name"
constant attribute
{}
top
os_a: STRING
is "a"
constant attribute
{}
top
os_ul: STRING
is "ul"
constant attribute
{}
top
os_dt: STRING
is "dt"
constant attribute
{}
top
os_dd: STRING
is "dd"
constant attribute
{}
top
os_dl: STRING
is "dl"
constant attribute
{}
top
os_ol: STRING
is "ol"
constant attribute
{}
top
os_li: STRING
is "li"
constant attribute
{}
top
os_table: STRING
is "table"
constant attribute
{}
top
os_tr: STRING
is "tr"
constant attribute
{}
top
os_td: STRING
is "td"
constant attribute
{}
top
os_method_get: STRING
is "GET"
constant attribute
{}
top
os_method_post: STRING
is "POST"
constant attribute
{}
top
os_method: STRING
is "method"
constant attribute
{}
top
os_action: STRING
is "action"
constant attribute
{}
top
os_form: STRING
is "form"
constant attribute
{}
top
os_rows: STRING
is "rows"
constant attribute
{}
top
os_cols: STRING
is "cols"
constant attribute
{}
top
os_textarea: STRING
is "textarea"
constant attribute
{}
top
os_submit: STRING
is "submit"
constant attribute
{}
top
os_button: STRING
is "button"
constant attribute
{}
top
os_reset: STRING
is "reset"
constant attribute
{}
top
os_hidden: STRING
is "hidden"
constant attribute
{}
top
os_password: STRING
is "password"
constant attribute
{}
top
os_text: STRING
is "text"
constant attribute
{}
top
os_radio: STRING
is "radio"
constant attribute
{}
top
os_checkbox: STRING
is "checkbox"
constant attribute
{}
top
os_select: STRING
is "select"
constant attribute
{}
top
os_multiple: STRING
is "multiple"
constant attribute
{}
top
os_value: STRING
is "value"
constant attribute
{}
top
os_option: STRING
is "option"
constant attribute
{}
top
os_type: STRING
is "type"
constant attribute
{}
top
os_checked: STRING
is "checked"
constant attribute
{}
top
os_input: STRING
is "input"
constant attribute
{}
top
os_frameset: STRING
is "frameset"
constant attribute
{}
top
os_frame: STRING
is "frame"
constant attribute
{}
top
os_noframes: STRING
is "noframes"
constant attribute
{}
top
os_paragraph: STRING
is "p"
constant attribute
{}
top
os_blockquote: STRING
is "blockquote"
constant attribute
{}
top
os_div: STRING
is "div"
constant attribute
{}
top
os_span: STRING
is "span"
constant attribute
{}
top
os: STRING
is ""
constant attribute
{}
top
used as a buffer
disconnect
effective procedure
{ANY}
top
Disconnect from the underlying stream.
do_detach
effective procedure
{STREAM}
top
Used by the underlying stream to require not to be filtered anymore
stream: OUTPUT_STREAM
writable attribute
{}
top
The underlying stream (i.e. the filtered one)
put_character (c: CHARACTER)
effective procedure
{ANY}
top
flush
effective procedure
{ANY}
top
Flushes the pipe.
detach
effective procedure
{ANY}
top
Shake off the filter.
writable attribute
{FILTER}
top
The filter that uses this stream as backend
event_can_write: EVENT_DESCRIPTOR
effective function
{ANY}
top
writable attribute
{}
top
new_url: URL
effective function
{}
top
as_output_stream: OUTPUT_STREAM
effective function
{}
top
is_connected: BOOLEAN
deferred function
{ANY}
top
True if the stream is connected.
descriptor: INTEGER_32
effective function
{ANY}
top
Some OS-dependent descriptor.
has_descriptor: BOOLEAN
effective function
{ANY}
top
True if that stream can be associated to some OS-meaningful descriptor.
can_disconnect: BOOLEAN
deferred function
{ANY}
top
True if the stream can be safely disconnected (without data loss, etc.)
url: URL
frozen
effective function
{ANY}
top
The URL to this stream as resource
url_memory: URL
writable attribute
{}
top
stream_pointer: POINTER
effective function
{STREAM_HANDLER}
top
Some Back-end-dependent pointer (FILE* in C, InputStream or OutputStream in Java)
has_stream_pointer: BOOLEAN
effective function
{STREAM_HANDLER}
top
True if that stream can be associated to some Back-end-meaningful stream pointer.
filtered_descriptor: INTEGER_32
deferred function
{FILTER}
top
Find the descriptor of the terminal stream...
filtered_has_descriptor: BOOLEAN
deferred function
{FILTER}
top
True if the underlying terminal stream has a descriptor
filtered_stream_pointer: POINTER
deferred function
{FILTER}
top
Find the pointer of the terminal stream...
filtered_has_stream_pointer: BOOLEAN
deferred function
{FILTER}
top
True if the underlying terminal stream has a pointer
event_exception: EVENT_DESCRIPTOR
effective function
{ANY}
top
stream_exception: STREAM_EXCEPTION
writable attribute
{}
top
recycle
effective procedure
{RECYCLING_POOL}
top
Do whatever needs to be done to free resources or recycle other objects when recycling this one
dispose
effective procedure
{}
top
Action to be executed just before garbage collection reclaims an object.
sequencer_descriptor (file: POINTER): INTEGER_32
{}
top
is_filtered: BOOLEAN
deferred function
{ANY}
top
put_natively_stored_string (s: NATIVELY_STORED_STRING)
effective procedure
{ABSTRACT_STRING}
top
put_abstract_string (s: ABSTRACT_STRING)
effective procedure
{ABSTRACT_STRING}
top
put_string (s: ABSTRACT_STRING)
effective procedure
{ANY}
top
Output s to current output device.
put_unicode_string (unicode_string: UNICODE_STRING)
effective procedure
{ANY}
top
Output the UTF-8 encoding of the unicode_string.
put_line (s: ABSTRACT_STRING)
effective procedure
{ANY}
top
Output the string followed by a '%N'.
put_integer (i: INTEGER_64)
frozen
effective procedure
{ANY}
top
Output i to current output device.
put_integer_format (i: INTEGER_64, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output i to current output device using at most s character.
put_natural_8 (n: NATURAL_8)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_8_format (n: NATURAL_8, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_natural_16 (n: NATURAL_16)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_16_format (n: NATURAL_16, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_natural_32 (n: NATURAL_32)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_32_format (n: NATURAL_32, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_natural_64 (n: NATURAL_64)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_64_format (n: NATURAL_64, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_real (r: REAL_64)
effective procedure
{ANY}
top
Output r to current output device.
put_real_format (r: REAL_64, f: INTEGER_32)
effective procedure
{ANY}
top
Output r with only f digit for the fractional part.
put_real_scientific (r: REAL_64, f: INTEGER_32)
effective procedure
{ANY}
top
Output r using the scientific notation with only f digit for the fractional part.
put_number (number: NUMBER)
effective procedure
{ANY}
top
Output the number.
put_boolean (b: BOOLEAN)
effective procedure
{ANY}
top
Output b to current output device according to the Eiffel format.
put_pointer (p: POINTER)
effective procedure
{ANY}
top
Output a viewable version of p.
put_new_line
effective procedure
{ANY}
top
Output a newline character.
put_spaces (nb: INTEGER_32)
effective procedure
{ANY}
top
Output nb spaces character.
append_file (file_name: STRING)
effective procedure
{ANY}
top
tmp_file_read: TEXT_FILE_READ
once function
{}
top
tmp_string: STRING
once function
{}
top
io_putc (byte: CHARACTER, stream: POINTER)
{}
top
io_fwrite (buf: NATIVE_ARRAY[CHARACTER], size: INTEGER_32, stream: POINTER): INTEGER_32
{}
top
io_flush (stream: POINTER)
{}
top
set_filter (a_filter: FILTER)
effective procedure
{FILTER}
top
Used by the filter itself to get attached