4.9.11 Options de représentation type htmltext

Les options de représentation indiquées dans la structure de la famille ne sont pas prises en compte dans les interfaces HTML5.

Le widget d'édition des textes formaté est basé sur un widget CKEditor.

4.9.11.1 setHeight

Cette option indique la hauteur de la zone d'écriture du widget d'édition.

Dcp\Ui\HtmltextRenderOptions setHeight(string $heigth)

4.9.11.1.1 Restrictions

  • Utilisable uniquement pour les rendus de modification ou de création.

4.9.11.1.2 Paramètres

L'argument height est une valeur avec unité (120px par défaut). Les unités possibles sont les unités css. Le pourcentage n'est pas une unité valide pour cette option.

Si l'unité n'est pas précisé, c'est l'unité px qui est utilisée.

4.9.11.1.3 Cas particuliers

Cette option est priroritaire à l'option setCkEditorConfiguration.

4.9.11.1.4 Exemples

Affichage d'une hauteur de 150px (Barre de menu non comprise).

$options->htmltext(My_family::my_article)->setHeight("150px");

4.9.11.2 setToolbarStartupExpanded

Cette option indique si la barre de menu doit être dépliée ou non lors de l'affichage du document.

Dcp\Ui\HtmltextRenderOptions setToolbarStartupExpanded(bool $expanded)

4.9.11.2.1 Restrictions

  • Utilisable uniquement pour les rendus de modification ou de création.

4.9.11.2.2 Paramètres

Si l'argument expanded est true (valeur par défaut), la barre de menu est visible. Si cette argument est false, la barre de menu est minimisée. Un bouton sur cette barre de menu permet de la déplier ou de la replier.

Cette option correspond à l'option toolbarStartupExpanded de CKEditor.

4.9.11.2.3 Cas particuliers

Cette option est priroritaire à l'option setCkEditorConfiguration.

4.9.11.2.4 Exemples

4.9.11.3 setToolbar

Cette option indique la barre de menu qui doit être disponible sur cet éditeur.

Dcp\Ui\HtmltextRenderOptions setToolbar(string $toolbar)

4.9.11.3.1 Restrictions

  • Utilisable uniquement pour les rendus de modification ou de création.

4.9.11.3.2 Paramètres

L'argument toolbar indique l'identifiant de la barre de menu à utiliser. La valeur par défaut est Simple.

Les valeurs prédéfinies sont :

Dcp\Ui\HtmltextRenderOptions::basicToolbar
Barre de menu *Basic*

Figure 49. Barre de menu *Basic*

Dcp\Ui\HtmltextRenderOptions::defaultToolbar
Barre de menu *Default*

Figure 50. Barre de menu *Default*

Dcp\Ui\HtmltextRenderOptions::simpleToolbar
Barre de menu *Simple*

Figure 51. Barre de menu *Simple*

Dcp\Ui\HtmltextRenderOptions::fullToolbar
Barre de menu *Full*

Figure 52. Barre de menu *Full*

Cette option correspond à l'option toolbar de CKEditor.

4.9.11.3.3 Cas particuliers

  • Attention : La barre de menu influence le contenu du texte saisi. Par exemple, si la barre de menu ne contient pas le bouton de coloriage des textes, les attributs de couleurs sont effacés.

    Il est possible d'inhiber ce filtrage en configurant l'option ckEditor allowedContent pour indiquer les tags autorisés ou l'option setCkEditorAllowAllTags pour tout autoriser. Dans ce cas, il est nécessaire de nettoyer le code de manière explicite pour éviter les balises non désirées.

  • Cette option est priroritaire à l'option setCkEditorConfiguration.

4.9.11.3.4 Exemples

Affichage du menu "Basic".

$options->htmltext(My_family::my_article)->setToolbar(\Dcp\Ui\HtmltextRenderOptions::basicToolbar);

4.9.11.4 setCkEditorConfiguration

Cette option permet de configurer le widget CKeditor.

Dcp\Ui\HtmltextRenderOptions setCkEditorConfiguration(array $config)

4.9.11.4.1 Restrictions

  • Utilisable uniquement pour les rendus de modification ou de création.

Attention : Les options propres à CKEditor ne sont pas maintenues par Anakeen et leur bon fonctionnement n'est pas garanti par Anakeen.

4.9.11.4.2 Paramètres

L'argument config permet de modifier les valeurs de configuration du widget CKeditor. Les valeurs possibles sont celles du widget CKEditor.

4.9.11.5 Cas particuliers

Aucun

4.9.11.5.1 Exemples

Configurer sa propre barre de menu avec seulement "Gras" et "Italique".

$options->htmltext(My_family::my_article)
    ->setToolbar("mySample")
    ->setCkEditorConfiguration([
        "toolbarCanCollapse" => false,
        "toolbar_mySample" => [
            "name" => "Basics",
            "items" => ["Bold", "Italic"]
        ]
    ]);

4.9.11.6 setCkEditorAllowAllTags

Cette option permet d'autoriser tous les tags HTML dans l'éditeur ckEditor. Par défaut, les tags autorisés sont fonctions de la barre de menu affichée.

Dcp\Ui\HtmltextRenderOptions setCkEditorConfiguration(bool $allow)

4.9.11.6.1 Restrictions

  • Utilisable uniquement pour les rendus de modification ou de création.

4.9.11.6.2 Paramètres

L'argument allow s'il faut true permet d'autoriser toute balise HTML supportée.

Les attributs de ces balises peuvent aussi être utilisées à l'exception des attributs commençant par on tel que onclick ou onmouseover.

Les balises supportées sont : a, abbr, acronym, address, applet, area, article, aside, audio, b, base, basefont, bdi, bdo, big, blockquote, body, br, button, canvas, caption, center, cite, code, col, colgroup, command, datalist, dd, del, details, dfn, dialog, dir, div, dl, dt, em, embed, fieldset, figcaption, figure, font, footer, form, h1, h2, h3, h4, h5, h6, head, header, hgroup, hr, html, i, iframe, img, input, ins, isindex, kbd, keygen, label, legend, li, link, main, map, mark, menu, meta, meter, nav, noframes, noscript, object, ol, optgroup, option, output, p, param, pre, progress, q, rp, rt, ruby, s, samp, section, select, small, source, span, strike, strong, style, sub, summary, sup, table, tbody, td, textarea, tfoot, th, thead, time, title, tr, track, tt, u, ul, var, video, wbr.

4.9.11.7 Cas particuliers

Aucun

4.9.11.7.1 Exemples

Affichage de la barre de menu complète et autorisation de tous les tags.

$options->htmltext(My_family::my_article)
    ->setToolbar(\Dcp\Ui\HtmltextRenderOptions::fullToolbar)
    ->setCkEditorAllowAllTags(true);

4.9.11.8 setAnchorsOptions

Cette option permet de définir les modalités d'ouverture des liens contenus dans cet attribut.

\Dcp\Ui\HtmltextRenderOptions::setAnchorsOptions(\Dcp\Ui\anchorOptions $anchorOptions)

4.9.11.9 Restrictions

Uniquement pris en compte lorsque l'attribut n'est pas en modification.

4.9.11.9.1 Paramètres

L'argument en entrée est un objet de type Dcp\Ui\anchorOptions qui configure les différents paramètres du lien :

target

Nom de la fenêtre du navigateur vers laquelle le lien sera envoyé.

  • Si la valeur est _blank (valeur par défaut), une nouvelle fenêtre est utilisée.
  • Si la valeur est _self, la fenêtre courante est utilisée.
  • Si la valeur est _dialog, une fenêtre de dialogue interne sera utilisée.

Si target est différente de _self les options suivantes sont prises en compte :

windowHeight

Hauteur de la fenêtre de dialogue. Si target est égal à _dialog, la dimension doit être une [dimension css valable][css_dimension] (c'est à dire un nombre suivi immédiatement de son unité).

Sinon la dimension est un nombre entier exprimé en pixels.

La valeur par défaut est 300px.

windowWidth

Largeur de la fenêtre de dialogue. Si target est égal à _dialog, la dimension doit être une [dimension css valable][css_dimension] (c'est à dire un nombre suivi immédiatement de son unité).

Sinon la dimension est un nombre entier exprimé en pixels.

La valeur par défaut est 200px.

Si target est _dialog, les options suivantes sont prises en compte :

modal
indique si la fenêtre de dialogue doit être modale (false par défaut).

4.9.11.10 Cas particuliers

Aucun

4.9.11.10.1 Exemples

Ouverture de tous les liens dans une modale de 400 x 300px.

$options->htmltext(My_family::my_article)
        ->setAnchorOptions(new \Dcp\Ui\anchorOptions('_dialog', '400px', '300px', true))
Source : server/renderConfig/attributeOptions/htmltextOptions.md Dynacase Platform 3.2 | Document User Interface Manuel de référence, version 1.0 édition 2, © Labs <labs@anakeen.com>
×
Publié sous licence CC (http://creativecommons.org/licenses/by-nc-sa/2.0/fr/) par Anakeen [www.anakeen.com]
Attribution Vous devez créditer l'Oeuvre, intégrer un lien vers la licence et indiquer si des modifications ont été effectuées à l'Oeuvre. Vous devez indiquer ces informations par tous les moyens possibles mais vous ne pouvez pas suggérer que l'Offrant vous soutient ou soutient la façon dont vous avez utilisé son Oeuvre.
Pas d’Utilisation Commerciale Vous n'êtes pas autoriser à faire un usage commercial de cette Oeuvre, tout ou partie du matériel la composant.
Partage dans les Mêmes Conditions Dans le cas où vous effectuez un remix, que vous transformez, ou créez à partir du matériel composant l'Oeuvre originale, vous devez diffuser l'Oeuvre modifiée dans les même conditions, c'est à dire avec la même licence avec laquelle l'Oeuvre originale a été diffusée.