~certify-web-dev/twisted/certify-trunk

<tr><td align="right">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.woven.widgets.Image.html" target="_top">no frames</a>]</td></tr>

</table></td>

</tr></table>

<h2 class="class">Class Image</h2>

<a href="twisted.web.woven.view.View.html"><code>View</code></a> --+

<a href="twisted.web.woven.widgets.Widget.html"><code>Widget</code></a> --+

Image

</pre>

<hr/>

A simple Widget that creates an `img' tag.

<hr/>

<th colspan="2">Method Summary</th></tr>

<td><code><a href="twisted.web.woven.widgets.Image.html#setUp" class="summary-sig-name"><code>setUp</code></a>(self,

request,

node,

data)</code>

Override this method to set up your Widget prior to generateDOM.</td></tr>

<th colspan="2">    Inherited from Widget</th></tr>

<td><code><a href="twisted.web.woven.widgets.Widget.html#__init__" class="summary-sig-name"><code>__init__</code></a>(self,

model,

submodel,

setup,

controller,

viewStack,

*args,

**kwargs)</code>

</td></tr>

<td><code><a href="twisted.web.woven.widgets.Widget.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(self,

item)</code>

Convenience syntax for getting an attribute from the resultant DOM

Node of this widget.</td></tr>

<td><code><a href="twisted.web.woven.widgets.Widget.html#__setitem__" class="summary-sig-name"><code>__setitem__</code></a>(self,

item,

value)</code>

Convenience syntax for adding attributes to the resultant DOM Node of

this widget.</td></tr>

<td><code><a href="twisted.web.woven.widgets.Widget.html#_regenerate" class="summary-sig-name"><code>_regenerate</code></a>(self,

request,

100

node,

101

data)</code>

102

</td></tr>

103

104

<td><code><a href="twisted.web.woven.widgets.Widget.html#_reset" class="summary-sig-name"><code>_reset</code></a>(self)</code>

105

</td></tr>

106

107

<td><code><a href="twisted.web.woven.widgets.Widget.html#add" class="summary-sig-name"><code>add</code></a>(self,

108

item)</code>

109

110

Add `item' to the children of the resultant DOM Node of this

111

widget.</td></tr>

112

113

<td><code><a href="twisted.web.woven.widgets.Widget.html#addEventHandler" class="summary-sig-name"><code>addEventHandler</code></a>(self,

114

eventName,

115

handler,

116

*args)</code>

117

118

Add an event handler to this widget.</td></tr>

119

120

<td><code><a href="twisted.web.woven.widgets.Widget.html#addUpdateMethod" class="summary-sig-name"><code>addUpdateMethod</code></a>(self,

121

updateMethod)</code>

122

123

Add a method to this widget that will be called when the widget is

124

being rendered.</td></tr>

125

126

<td><code><a href="twisted.web.woven.widgets.Widget.html#appendChild" class="summary-sig-name"><code>appendChild</code></a>(self,

127

item)</code>

128

129

Add `item' to the children of the resultant DOM Node of this

130

widget.</td></tr>

131

132

<td><code><a href="twisted.web.woven.widgets.Widget.html#cleanNode" class="summary-sig-name"><code>cleanNode</code></a>(self,

133

node)</code>

134

135

Do your part, prevent infinite recursion!</td></tr>

136

137

<td><code><a href="twisted.web.woven.widgets.Widget.html#generate" class="summary-sig-name"><code>generate</code></a>(self,

138

request,

139

node)</code>

140

141

Allow a view to be used like a widget.</td></tr>

142

143

<td><code><a href="twisted.web.woven.widgets.Widget.html#generateDOM" class="summary-sig-name"><code>generateDOM</code></a>(self,

144

request,

145

node)</code>

146

147

Return a DOM Node to replace the Node in the template that this Widget

148

handles.</td></tr>

149

150

<td><code><a href="twisted.web.woven.widgets.Widget.html#getAllPatterns" class="summary-sig-name"><code>getAllPatterns</code></a>(self,

151

name,

152

default,

153

clone,

154

deep)</code>

155

156

Get all nodes below this one which have a matching pattern

157

attribute.</td></tr>

158

159

<td><code><a href="twisted.web.woven.widgets.Widget.html#__getitem__" class="summary-sig-name"><code>getAttribute</code></a>(self,

160

item)</code>

161

162

Convenience syntax for getting an attribute from the resultant DOM

163

Node of this widget.</td></tr>

164

165

<td><code><a href="twisted.web.woven.widgets.Widget.html#getData" class="summary-sig-name"><code>getData</code></a>(self,

166

request)</code>

167

168

I have a model; however since I am a widget I am only responsible for

169

a portion of that model.</td></tr>

170

171

<td><code><a href="twisted.web.woven.widgets.Widget.html#getPattern" class="summary-sig-name"><code>getPattern</code></a>(self,

172

name,

173

default,

174

clone,

175

deep)</code>

176

177

Get a named slot from the incoming template node.</td></tr>

178

179

<td><code><a href="twisted.web.woven.widgets.Widget.html#getTopModel" class="summary-sig-name"><code>getTopModel</code></a>(self)</code>

180

181

Get a reference to this page's top model object.</td></tr>

182

183

<td><code><a href="twisted.web.woven.widgets.Widget.html#initialize" class="summary-sig-name"><code>initialize</code></a>(self,

184

*args,

185

**kwargs)</code>

186

187

Use this method instead of __init__ to initialize your Widget, so you

188

don't have to deal with calling the __init__ of the superclass.</td></tr>

189

190

<td><code><a href="twisted.web.woven.widgets.Widget.html#insert" class="summary-sig-name"><code>insert</code></a>(self,

191

index,

192

item)</code>

193

194

Insert `item' at `index' in the children list of the resultant DOM

195

Node of this widget.</td></tr>

196

197

<td><code><a href="twisted.web.woven.widgets.Widget.html#modelChanged" class="summary-sig-name"><code>modelChanged</code></a>(self,

198

payload)</code>

199

</td></tr>

200

201

<td><code><a href="twisted.web.woven.widgets.Widget.html#onEvent" class="summary-sig-name"><code>onEvent</code></a>(self,

202

request,

203

eventName,

204

*args)</code>

205

206

Dispatch a client-side event to an event handler that was registered

207

using addEventHandler.</td></tr>

208

209

<td><code><a href="twisted.web.woven.widgets.Widget.html#__setitem__" class="summary-sig-name"><code>setAttribute</code></a>(self,

210

item,

211

value)</code>

212

213

Convenience syntax for adding attributes to the resultant DOM Node of

214

this widget.</td></tr>

215

216

<td><code><a href="twisted.web.woven.widgets.Widget.html#setData" class="summary-sig-name"><code>setData</code></a>(self,

217

request,

218

data)</code>

219

220

If the return value of <a

221

href="twisted.web.woven.widgets.Widget.html#getData"

222

class="link"><code>getData</code></a> is a Deferred, I am called when the

223

result of the Deferred is available.</td></tr>

224

225

<td><code><a href="twisted.web.woven.widgets.Widget.html#setDataCallback" class="summary-sig-name"><code>setDataCallback</code></a>(self,

226

result,

227

request,

228

node)</code>

229

</td></tr>

230

231

<td><code><a href="twisted.web.woven.widgets.Widget.html#setError" class="summary-sig-name"><code>setError</code></a>(self,

232

request,

233

message)</code>

234

235

Convenience method for allowing a Controller to report an error to the

236

user.</td></tr>

237

238

<td><code><a href="twisted.web.woven.widgets.Widget.html#setNode" class="summary-sig-name"><code>setNode</code></a>(self,

239

node)</code>

240

241

Set a node for this widget to use instead of creating one

242

programatically.</td></tr>

243

244

<td><code><a href="twisted.web.woven.widgets.Widget.html#setSubmodel" class="summary-sig-name"><code>setSubmodel</code></a>(self,

245

submodel)</code>

246

247

I use the submodel to know which attribute in self.model I am

248

responsible for</td></tr>

249

250

<th colspan="2">    Inherited from View</th></tr>

251

252

<td><code><a href="twisted.web.woven.view.View.html#dispatchResult" class="summary-sig-name"><code>dispatchResult</code></a>(self,

253

request,

254

node,

255

result)</code>

256

257

Check a given result from handling a node and look up a NodeMutator

258

adapter which will convert the result into a node and insert it into the

259

DOM tree.</td></tr>

260

261

<td><code><a href="twisted.web.woven.view.View.html#dispatchResultCallback" class="summary-sig-name"><code>dispatchResultCallback</code></a>(self,

262

result,

263

request,

264

node)</code>

265

266

Deal with a callback from a deferred, checking to see if it is ok to

267

send the page yet or not.</td></tr>

268

269

<td><code><a href="twisted.web.woven.view.View.html#getChild" class="summary-sig-name"><code>getChild</code></a>(self,

270

path,

271

request)</code>

272

</td></tr>

273

274

<td><code><a href="twisted.web.woven.view.View.html#getChildWithDefault" class="summary-sig-name"><code>getChildWithDefault</code></a>(self,

275

path,

276

request)</code>

277

</td></tr>

278

279

<td><code><a href="twisted.web.woven.view.View.html#getNodeController" class="summary-sig-name"><code>getNodeController</code></a>(self,

280

request,

281

node,

282

submodel,

283

model)</code>

284

285

Get a controller object to handle this node.</td></tr>

286

287

<td><code><a href="twisted.web.woven.view.View.html#getNodeModel" class="summary-sig-name"><code>getNodeModel</code></a>(self,

288

request,

289

node,

290

submodel)</code>

291

292

Get the model object associated with this node.</td></tr>

293

294

<td><code><a href="twisted.web.woven.view.View.html#getNodeView" class="summary-sig-name"><code>getNodeView</code></a>(self,

295

request,

296

node,

297

submodel,

298

model)</code>

299

</td></tr>

300

301

<td><code><a href="twisted.web.woven.view.View.html#getSubview" class="summary-sig-name"><code>getSubview</code></a>(self,

302

request,

303

node,

304

model,

305

viewName)</code>

306

307

Get a sub-view from me.</td></tr>

308

309

<td><code><a href="twisted.web.woven.view.View.html#getTemplate" class="summary-sig-name"><code>getTemplate</code></a>(self,

310

request)</code>

311

312

Override this if you want to have your subclass look up its template

313

using a different method.</td></tr>

314

315

<td><code><a href="twisted.web.woven.view.View.html#handleControllerResults" class="summary-sig-name"><code>handleControllerResults</code></a>(self,

316

controllerResult,

317

request,

318

node,

319

controller,

320

view)</code>

321

322

Handle a deferred from a controller.</td></tr>

323

324

<td><code><a href="twisted.web.woven.view.View.html#handleDocument" class="summary-sig-name"><code>handleDocument</code></a>(self,

325

request,

326

document)</code>

327

328

Handle the root node, and send the page if there are no outstanding

329

callbacks when it returns.</td></tr>

330

331

<td><code><a href="twisted.web.woven.view.View.html#handleNewNode" class="summary-sig-name"><code>handleNewNode</code></a>(self,

332

request,

333

returnNode)</code>

334

</td></tr>

335

336

<td><code><a href="twisted.web.woven.view.View.html#handleNode" class="summary-sig-name"><code>handleNode</code></a>(self,

337

request,

338

node)</code>

339

</td></tr>

340

341

<td><code><a href="twisted.web.woven.view.View.html#handleOutstanding" class="summary-sig-name"><code>handleOutstanding</code></a>(self,

342

request)</code>

343

</td></tr>

344

345

<td><code><a href="twisted.web.woven.view.View.html#importViewLibrary" class="summary-sig-name"><code>importViewLibrary</code></a>(self,

346

namespace)</code>

347

</td></tr>

348

349

<td><code><a href="twisted.web.woven.view.View.html#lookupTemplate" class="summary-sig-name"><code>lookupTemplate</code></a>(self,

350

request)</code>

351

352

Use acquisition to look up the template named by self.templateFile,

353

located anywhere above this object in the heirarchy, and use it as the

354

template.</td></tr>

355

356

<td><code><a href="twisted.web.woven.view.View.html#recurseChildren" class="summary-sig-name"><code>recurseChildren</code></a>(self,

357

request,

358

node)</code>

359

360

If this node has children, handle them.</td></tr>

361

362

<td><code><a href="twisted.web.woven.view.View.html#render" class="summary-sig-name"><code>render</code></a>(self,

363

request,

364

doneCallback)</code>

365

</td></tr>

366

367

<td><code><a href="twisted.web.woven.view.View.html#renderFailure" class="summary-sig-name"><code>renderFailure</code></a>(self,

368

failure,

369

request)</code>

370

</td></tr>

371

372

<td><code><a href="twisted.web.woven.view.View.html#sendPage" class="summary-sig-name"><code>sendPage</code></a>(self,

373

request)</code>

374

375

Check to see if handlers recorded any errors before sending the

376

page</td></tr>

377

378

<td><code><a href="twisted.web.woven.view.View.html#setController" class="summary-sig-name"><code>setController</code></a>(self,

379

controller)</code>

380

</td></tr>

381

382

<td><code><a href="twisted.web.woven.view.View.html#setSubviewFactory" class="summary-sig-name"><code>setSubviewFactory</code></a>(self,

383

name,

384

factory,

385

setup,

386

*args,

387

**kwargs)</code>

388

</td></tr>

389

390

<td><code><a href="twisted.web.woven.view.View.html#setupAllStacks" class="summary-sig-name"><code>setupAllStacks</code></a>(self)</code>

391

</td></tr>

392

393

<td><code><a href="twisted.web.woven.view.View.html#setupViewStack" class="summary-sig-name"><code>setupViewStack</code></a>(self)</code>

394

</td></tr>

395

396

<td><code><a href="twisted.web.woven.view.View.html#unlinkViews" class="summary-sig-name"><code>unlinkViews</code></a>(self)</code>

397

</td></tr>

398

</table>

399

400

401

402

403

404

<th colspan="2">Instance Variable Summary</th></tr>

405

406

<th colspan="2">    Inherited from Widget</th></tr>

407

408

<td><a href="twisted.web.woven.widgets.Widget.html#model"><code>model</code></a>: If the current model is an <a

409

href="twisted.web.woven.model.Model.html"

410

class="link"><code>model.Model</code></a>, then the result of

411

model.getData().</td></tr>

412

</table>

413

414

415

416

417

418

<th colspan="2">Class Variable Summary</th></tr>

419

420

<td><a href="twisted.web.woven.widgets.Image.html#border"><code>border</code></a> = <code>'0' </code>

421

</td></tr>

422

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

423

<td><a href="twisted.web.woven.widgets.Image.html#tagName"><code>tagName</code></a>: The tag name of the element that this widget creates.</td></tr>

424

425

<th colspan="2">    Inherited from Widget</th></tr>

426

427

<td><a href="twisted.web.woven.widgets.Widget.html#clearNode"><code>clearNode</code></a> = 0                                                                     </td></tr>

428

429

<td><a href="twisted.web.woven.widgets.Widget.html#livePage"><code>livePage</code></a> = 1                                                                     </td></tr>

430

431

<td><a href="twisted.web.woven.widgets.Widget.html#setupStacks"><code>setupStacks</code></a> = 0                                                                     </td></tr>

432

433

<td><a href="twisted.web.woven.widgets.Widget.html#wantsAllNotifications"><code>wantsAllNotifications</code></a>: Indicate that this widget wants to recieve every change notification

434

from the main model, not just notifications that affect its model.</td></tr>

435

436

<th colspan="2">    Inherited from View</th></tr>

437

<tr><td align="right" valign="top" width="15%"><code>tuple</code></td>

438

<td><a href="twisted.web.woven.view.View.html#__implements__"><code>__implements__</code></a> = , <class twisted.web.woven.interfaces.IView at 0x85936d4>)"><code>(<class twisted.web.resource.IResource ...</code>

439

</td></tr>

440

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

441

<td><a href="twisted.web.woven.view.View.html#doneCallback"><code>doneCallback</code></a> = None                                                                  </td></tr>

442

443

<td><a href="twisted.web.woven.view.View.html#isLeaf"><code>isLeaf</code></a> = 1                                                                     </td></tr>

444

445

<td><a href="twisted.web.woven.view.View.html#template"><code>template</code></a> = <code>'' </code>

446

</td></tr>

447

448

<td><a href="twisted.web.woven.view.View.html#templateDirectory"><code>templateDirectory</code></a> = <code>'' </code>

449

</td></tr>

450

451

<td><a href="twisted.web.woven.view.View.html#templateFile"><code>templateFile</code></a> = <code>'' </code>

452

</td></tr>

453

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

454

<td><a href="twisted.web.woven.view.View.html#templateNode"><code>templateNode</code></a> = None                                                                  </td></tr>

455

456

<td><a href="twisted.web.woven.view.View.html#viewLibraries"><code>viewLibraries</code></a> = <code>[] </code>

457

</td></tr>

458

</table>

459

460

461

462

463

464

<th colspan="2">Method Details</th></tr>

465

</table>

466

467

468

469

<h3>setUp(self,

470

request,

471

node,

472

data)

473

</h3>

474

Override this method to set up your Widget prior to generateDOM.

475

This is a good place to call methods like <a

476

href="twisted.web.woven.widgets.Widget.html#add"

477

class="link"><code>add</code></a>, <a

478

href="twisted.web.woven.widgets.Widget.html#insert"

479

class="link"><code>insert</code></a>, <a

480

href="twisted.web.woven.widgets.Widget.html#__setitem__"

481

class="link"><code>__setitem__</code></a> and <a

482

href="twisted.web.woven.widgets.Widget.html#__getitem__"

483

class="link"><code>__getitem__</code></a>.

484

Overriding this method obsoletes overriding generateDOM directly, in

485

most cases.

486

487

<dl><dt>Parameters:</dt>

488

<dd><code>request</code>

489

490

(type=<a href="twisted.web.server.Request.html"

491

class="link"><code>twisted.web.server.Request</code></a>.)

492

<dd><code>node</code> -

493

The DOM node which this Widget is operating on.

494

<dd><code>data</code> -

495

The Model data this Widget is meant to operate upon.

496

</dd>

497

</dl>

498

<dl><dt>Overrides:</dt>

499

<dd><a href="twisted.web.woven.widgets.Widget.html#setUp"><code>twisted.web.woven.widgets.Widget.setUp</code></a> (inherited documentation)

500

</dd>

501

</dl>

502

</dd></dl>

503

</td></tr></table>

504

505

506

507

508

509

510

<th colspan="2">Class Variable Details</th></tr>

511

</table>

512

513

514

<h3>border</h3>

515

<dl>

516

517

<dd>

518

<dl>

519

520

<dd>

521

522

523

</dd>

524

<dt>Value:</dt>

525

526

527

'0' </pre>

528

</td></tr></table></dd>

529

</dl>

530

</dd>

531

</dl></td></tr></table>

532

533

534

<h3>tagName</h3>

535

The tag name of the element that this widget creates. If this is None,

536

then the original Node will be cloned.

537

<dl>

538

539

<dd>

540

<dl>

541

542

<dd>

543

<code>NoneType</code>

544

545

</dd>

546

<dt>Value:</dt>

547

548

549

'img' </pre>

550

</td></tr></table></dd>

551

</dl>

552

</dd>

553

</dl></td></tr></table>

554

555

556

557

558

559

560

561

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

562

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

563

564

565

566

567

568

<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>

569

</th></tr></table>

570

</th>

571

</tr>

572

</table>

573

574

575

<tr>

576

<td align="left">Generated by Epydoc 2.0 on Sat May 15 20:08:35 2004</td>

577

<td align="right"><a href="http://epydoc.sourceforge.net"

578

>http://epydoc.sf.net</a></td>

579

</tr>

580

</table>

581

</body>

582

</html>

Older »