4.9.9 Options de représentation type file

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

4.9.9.1 setContentDispositionInline

Cette option indique si le fichier à télécharger peut être consulté directement depuis le navigateur.

Dcp\Ui\FileRenderOptions setContentDispositionInline(bool $inline)

4.9.9.1.1 Restrictions

• Utilisable uniquement pour les rendus de consultation.

4.9.9.1.2 Paramètres

Si l'argument inline est false(par défaut), le fichier est proposé au téléchargement lorsqu'on clique sur le lien. Si la valeur est true, le fichier sera affiché sur le navigateur si celui-ci prend en compte son format.

Note : Les options de liens sont applicables sur le l'hyperlien généré.

4.9.9.1.3 Cas particuliers

Aucun

4.9.9.1.4 Exemples

Affichage direct sur une page différente

$fileLink=new \Dcp\Ui\HtmlLinkOptions();
$fileLink->target="_blank";
$options->file(My_family::my_abstract)
    ->setLink($fileLink)
    ->setContentDispositionInline(true);

4.9.9.2 setTranslations

En plus des labels communs à tous les types d'attributs, les labels sur le widget de choix de fichier peuvent être configurés.

Dcp\Ui\FileRenderOptions setTranslations(array $labels)

4.9.9.2.1 Restrictions

• Utilisable pour les rendus de modification ou de consultation.

4.9.9.2.2 Paramètres

Les labels suivants utilisés en modification peuvent être changés :

• dropFileHere: "Déposer le fichier ici"
• tooltipLabel: "Choisissez un fichier"
• downloadLabel: "Télécharger le fichier"
• recording: "Enregistrement"
• transferring: "Téléversement de"

Les textes de ces labels sont différents pour le type image.

Les labels suivants sont utilisés en consultation pour afficher la taille du fichier dans le tooltip :

• kiloByte: "Ko"
• byte: "octets"

4.9.9.2.3 Cas particuliers

4.9.9.2.4 Exemples

Modification des traductions.

$options->file("my_file")
    ->setTranslations([
        "tooltipLabel"=>"Choisissez un plan",
    ]);

4.9.9.3 setPlaceHolder

Cette option indique un texte qui est placé dans le champ de saisie lorsque la valeur est vide pour préciser le rôle de ce champ.

Dcp\Ui\FileRenderOptions setPlaceHolder(string $text)

4.9.9.3.1 Restrictions

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

4.9.9.3.2 Paramètres

L'argument $text est un texte simple (pas de html) qui sera utilisé comme placeholder du champ lorsque le champ est vide.

4.9.9.3.3 Cas particuliers

Aucun

4.9.9.3.4 Exemples

$options->file(My_family::my_file)->setPlaceHolder("Select a pdf file, please.");

4.9.9.4 setMimeIconSize

Cette option indique la dimension de l'icône du type mime du fichier.

Dcp\Ui\FileRenderOptions setMimeIconSize(string $size)

4.9.9.4.1 Restrictions

• Utilisable pour les rendus de consultation et de modification.

4.9.9.4.2 Paramètres

L'argument size indique la dimension de l'image à afficher.

Par défaut, la dimension est 20x20c. Cela affiche une icône carrée de 20px.

Le redimensionnement ne peut excéder la taille de l'icône originale qui est de 80x80px.

Cette option ne modifie pas la taille css mais affiche une icône à la dimension désirée. Le poids du fichier icône est proportionnel à la taille demandée.

4.9.9.4.3 Cas particuliers

Pour rétablir la taille par défaut, il faut indiquer null. Une dimension de 0 ou de 0x0, n'affiche par l'icône.

Sur le formulaire, l'icône est utilisée en image de fond (background-image) du champ de saisie (input). Elle ne peut dépasser la dimension du champ de saisie.

Les attributs de type "image" n'utilisent pas cette icône dans leur représentation par défaut.

4.9.9.4.4 Exemples

Dimension de 32x32 rognée.

$options->file(My_family::my_file)->setMimeIconSize("32x32c");