The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Quiq-1.220
River stage zero No dependents
/ Quiq::Html::Page

NAME

Quiq::Html::Page - HTML-Seite

BASE CLASS

Quiq::Html::Base

SYNOPSIS

use Quiq::Html::Page;

$h = Quiq::Html::Producer->new;

$obj = Quiq::Html::Page->new(
    body => 'hello world!',
);

$html = $obj->html($h);

ATTRIBUTES

body => $str (Default: '')

Rumpf der Seite.

bodyOnly => $bool (Default: 0)

Liefere als Returnwert von asHtml() nur den Body anstelle der Gesamtseite.

comment => $str (Default: undef)

Kommentar am Anfang der Seite.

components => \@components

Liste der HTML-Komponenten, die in die Seite eingesetzt werden. Die Komponentenbestandteile werden automatisch zu den Seitenbestandteilen hinzugefüht. Im Seiten-HTML-Code wird der HTML-Code der Komponente an der Postion des Platzhalters __<NAME>__ eingesetzt.

encoding => $charset (Default: 'utf-8')

Encoding der Seite, z.B. 'iso-8859-1'.

head => $str (Default: '')

Kopf der Seite.

load => \@arr

Liste von Ladeanweisungen für CSS- und JavaScript-Dateien. Die Ladeanweisungen werden vor anderem CSS- und JavaScript-Code (s. Attribute javaScript und styleSheet) in den Head der Seite geschrieben. Eine CSS-Datei wird durch die Angabe eines Paars css => $url, eine JavaScript-Datei durch die Angabe eines Paars js => $url geladen. Hat $url die Endung .css oder .js, kann die Typangabe auch weggelassen werden. Beispiel:

load => [
    css => 'https://code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css',
    js => 'https://code.jquery.com/ui/1.12.1/jquery-ui.min.js',
],

Oder kurz (da die Dateiendungen den Typ verraten):

load => [
    'https://code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css',
    'https://code.jquery.com/ui/1.12.1/jquery-ui.min.js',
],
noNewline => $bool (Default: 0)

Füge kein Newline am Ende der Seite hinzu.

placeholders => \@keyVal (Default: [])

Ersetze im generierten HTML-Code die angegebenen Platzhalter durch ihre Werte.

javaScript => $url|$jsCode|[...] (Default: undef)

URL oder JavaScript-Code am Ende der Seite. Mehrfach-Definition, wenn Array-Referenz. Das Attribut kann mehrfach auftreten, die Werte werden zu einer Liste zusammengefügt.

javaScriptToHead => $bool (Default: 0)

Setze den JavaScrip-Code nicht an das Ende des Body, sondern in den Head der HTML-Seite.

ready => $jsCode (Default: [])

Führe JavaScript-Code $jsCode aus, wenn das DOM geladen ist. Dies ist so implementiert, dass der Code in einen jQuery ready-Handler eingebettet wird:

$(function() {
    $jsCode
});

Das Konstrukt setzt also jQuery voraus. Das Attribut kann mehrfach auftreten, es werden dann mehrere ready-Handler aufgesetzt.

styleSheet => $spec | \@specs (Default: undef)

Einzelne Style-Spezifikation oder Liste von Style-Spezifikationen. Siehe Methode Quiq::Css->style(). Das Attribut kann mehrfach auftreten, die Werte werden zu einer Liste zusammengefügt.

title => $str (Default: undef)

Titel der Seite.

topIndentation => $n (Default: 2)

Einrückung des Inhalts der obersten Elemente <head> und <body>.

METHODS

Konstruktor

new() - Konstruktor

Synopsis

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

Objektmethoden

html() - Generiere HTML

Synopsis

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

VERSION

1.220

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2024 Frank Seitz

LICENSE

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