[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / module-formatter.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-email.html" />
<link rel="prev" href="netdata.html" />
<link rel="parent" href="netdata.html" />
<link rel="next" href="formatter-interface.html" />
<meta name='aesop' content='information' />
<title>12.1 formatter -- Generic output formatting</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12. Internet Data Handling"
  href="netdata.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="12. Internet Data Handling"
  href="netdata.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="12.1.1 The Formatter Interface"
  href="formatter-interface.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="netdata.html">12. Internet Data Handling</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="netdata.html">12. Internet Data Handling</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="formatter-interface.html">12.1.1 The Formatter Interface</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0014100000000000000000">
12.1 <tt class="module">formatter</tt> --
         Generic output formatting</A>
</H1>

<P>
<A NAME="module-formatter"></A>

<P>
This module supports two interface definitions, each with multiple
implementations.  The <em>formatter</em> interface is used by the
<tt class="class">HTMLParser</tt> class of the <tt class="module"><a href="module-htmllib.html">htmllib</a></tt> module, and the
<em>writer</em> interface is required by the formatter interface.
<a id='l2h-3790' xml:id='l2h-3790'></a>
<P>
Formatter objects transform an abstract flow of formatting events into
specific output events on writer objects.  Formatters manage several
stack structures to allow various properties of a writer object to be
changed and restored; writers need not be able to handle relative
changes nor any sort of ``change back'' operation.  Specific writer
properties which may be controlled via formatter objects are
horizontal alignment, font, and left margin indentations.  A mechanism
is provided which supports providing arbitrary, non-exclusive style
settings to a writer as well.  Additional interfaces facilitate
formatting events which are not reversible, such as paragraph
separation.

<P>
Writer objects encapsulate device interfaces.  Abstract devices, such
as file formats, are supported as well as physical devices.  The
provided implementations all work with abstract devices.  The
interface makes available mechanisms for setting the properties which
formatter objects manage and inserting data into the output.

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="formatter-interface.html">12.1.1 The Formatter Interface</a>
<LI><A href="formatter-impls.html">12.1.2 Formatter Implementations</a>
<LI><A href="writer-interface.html">12.1.3 The Writer Interface</a>
<LI><A href="writer-impls.html">12.1.4 Writer Implementations</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12. Internet Data Handling"
  href="netdata.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="12. Internet Data Handling"
  href="netdata.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="12.1.1 The Formatter Interface"
  href="formatter-interface.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="netdata.html">12. Internet Data Handling</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="netdata.html">12. Internet Data Handling</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="formatter-interface.html">12.1.1 The Formatter Interface</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="module-email.html" />
	13	<link rel="prev" href="netdata.html" />
	14	<link rel="parent" href="netdata.html" />
	15	<link rel="next" href="formatter-interface.html" />
	16	<meta name='aesop' content='information' />
	17	<title>12.1 formatter -- Generic output formatting</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="12. Internet Data Handling"
	25	href="netdata.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="12. Internet Data Handling"
	28	href="netdata.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="12.1.1 The Formatter Interface"
	31	href="formatter-interface.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="netdata.html">12. Internet Data Handling</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="netdata.html">12. Internet Data Handling</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="formatter-interface.html">12.1.1 The Formatter Interface</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION0014100000000000000000">
	56	12.1 <tt class="module">formatter</tt> --
	57	Generic output formatting</A>
	58	</H1>
	59
	60	<P>
	61	<A NAME="module-formatter"></A>
	62
	63	<P>
	64	This module supports two interface definitions, each with multiple
65	implementations. The <em>formatter</em> interface is used by the
66	<tt class="class">HTMLParser</tt> class of the <tt class="module"><a href="module-htmllib.html">htmllib</a></tt> module, and the
67	<em>writer</em> interface is required by the formatter interface.
68	<a id='l2h-3790' xml:id='l2h-3790'></a>
69	<P>
70	Formatter objects transform an abstract flow of formatting events into
71	specific output events on writer objects. Formatters manage several
72	stack structures to allow various properties of a writer object to be
73	changed and restored; writers need not be able to handle relative
74	changes nor any sort of ``change back'' operation. Specific writer
75	properties which may be controlled via formatter objects are
76	horizontal alignment, font, and left margin indentations. A mechanism
77	is provided which supports providing arbitrary, non-exclusive style
78	settings to a writer as well. Additional interfaces facilitate
79	formatting events which are not reversible, such as paragraph
80	separation.
81
82	<P>
83	Writer objects encapsulate device interfaces. Abstract devices, such
84	as file formats, are supported as well as physical devices. The
85	provided implementations all work with abstract devices. The
86	interface makes available mechanisms for setting the properties which
87	formatter objects manage and inserting data into the output.
88
89	<P>
90
91	<p><br /></p><hr class='online-navigation' />
92	<div class='online-navigation'>
93	<!--Table of Child-Links-->
94	<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>
95
96	<UL CLASS="ChildLinks">
97	<LI><A href="formatter-interface.html">12.1.1 The Formatter Interface</a>
98	<LI><A href="formatter-impls.html">12.1.2 Formatter Implementations</a>
99	<LI><A href="writer-interface.html">12.1.3 The Writer Interface</a>
100	<LI><A href="writer-impls.html">12.1.4 Writer Implementations</a>
101	</ul>
102	<!--End of Table of Child-Links-->
103	</div>
104
105	<DIV CLASS="navigation">
106	<div class='online-navigation'>
107	<p></p><hr />
108	<table align="center" width="100%" cellpadding="0" cellspacing="2">
109	<tr>
110	<td class='online-navigation'><a rel="prev" title="12. Internet Data Handling"
111	href="netdata.html"><img src='../icons/previous.png'
112	border='0' height='32' alt='Previous Page' width='32' /></A></td>
113	<td class='online-navigation'><a rel="parent" title="12. Internet Data Handling"
114	href="netdata.html"><img src='../icons/up.png'
115	border='0' height='32' alt='Up One Level' width='32' /></A></td>
116	<td class='online-navigation'><a rel="next" title="12.1.1 The Formatter Interface"
117	href="formatter-interface.html"><img src='../icons/next.png'
118	border='0' height='32' alt='Next Page' width='32' /></A></td>
119	<td align="center" width="100%">Python Library Reference</td>
120	<td class='online-navigation'><a rel="contents" title="Table of Contents"
121	href="contents.html"><img src='../icons/contents.png'
122	border='0' height='32' alt='Contents' width='32' /></A></td>
123	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
124	border='0' height='32' alt='Module Index' width='32' /></a></td>
125	<td class='online-navigation'><a rel="index" title="Index"
126	href="genindex.html"><img src='../icons/index.png'
127	border='0' height='32' alt='Index' width='32' /></A></td>
128	</tr></table>
129	<div class='online-navigation'>
130	<b class="navlabel">Previous:</b>
131	<a class="sectref" rel="prev" href="netdata.html">12. Internet Data Handling</A>
132	<b class="navlabel">Up:</b>
133	<a class="sectref" rel="parent" href="netdata.html">12. Internet Data Handling</A>
134	<b class="navlabel">Next:</b>
135	<a class="sectref" rel="next" href="formatter-interface.html">12.1.1 The Formatter Interface</A>
136	</div>
137	</div>
138	<hr />
139	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
140	</DIV>
141	<!--End of Navigation Panel-->
142	<ADDRESS>
143	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
144	</ADDRESS>
145	</BODY>
146	</HTML>