/ 
Quiq-1.205
River stage zero No dependents
/ Quiq::Html::List

NAME

Quiq::Html::List - HTML-Aufzählungsliste

BASE CLASS

Quiq::Html::Base

DESCRIPTION

Die Klasse dient der Erzeugung von Aufzählungslisten in HTML. Sie kann die Listenarten

  • Ordered List (<ol>)

  • Unordered List (<ul>)

  • Description List (<dl>)

erzeugen. Siehe Abschnitt EXAMPLES.

ATTRIBUTES

isText => $bool (Default: 0)

Der Content aller List-Items besteht aus Text, d.h. <, >, & werden geschützt.

items => \@arr (Default: [])

Content der List-Items.

type => 'ordered' | 'unordered' | 'description' (Default: 'unordered')

Legt fest, ob die Aufzählungsliste eine Ordered List (<ol>), eine Unordered List (<ul>) oder eine Description List (<dl>) ist.

EXAMPLES

Unordered List

Die Unordered List ist der Default.

Der Aufruf

$html = Quiq::Html::List->html($h,
    id => 'list01',
    class => 'list',
    isText => 1,
    items => ['Apfel & Birne','Orange','Pflaume','Zitrone'],
);

liefert

<ul id="list01" class="list">
  <li>Apfel &amp; Birne</li>
  <li>Orange</li>
  <li>Pflaume</li>
  <li>Zitrone</li>
</ul>

Ordered List

Eine Ordered List wird bei Setzung des Attributs type=>'ordered' erzeugt.

Der Aufruf

$html = Quiq::Html::List->html($h,
    type => 'ordered',
    id => 'list02',
    class => 'list',
    isText => 1,
    items => ['Apfel & Birne','Orange','Pflaume','Zitrone'],
);

liefert

<ol id="list02" class="list">
  <li>Apfel &amp; Birne</li>
  <li>Orange</li>
  <li>Pflaume</li>
  <li>Zitrone</li>
</ol>

METHODS

Konstruktor

new() - Instantiiere Objekt

Synopsis

$obj = $class->new(@keyVal);

Description

Instantiiere ein Aufzählungslisten-Objekt und liefere eine Referenz auf dieses Objekt zurück.

Objektmethoden

html() - Generiere HTML

Synopsis

$html = $obj->html($h);
$html = $class->html($h,@keyVal);

Description

Generiere den HTML-Code eines Aufzählungslisten-Objekts und liefere diesen zurück. Als Klassenmethode gerufen, wird das Objekt intern erzeugt und mit den Attributen @keyVal instantiiert.

VERSION

1.205

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2022 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.