Manuel - Label

Introduction

Cette classe permet d'ajouter du texte autour du code-barres en utilisant des caractéristiques spécifiques.

Méthodes

Méthodes de BCGLabel

Exemple de Code


// Pour obtenir un exemple de l'utilisation de cette classe, voyez une classe de code-barres.

Explications des Méthodes

  • BCGLabel(text, font, position, alignment) — Crée un texte avec les arguments par défaut ou spécifiques
    Description
    Crée la classe. Vous pouvez utiliser aucun argument pour créer le texte par défaut, ou spécifier les arguments à l'avance.
    Voyez les méthodes appropriées pour plus d'informations.
  • getText() — Récupère le texte associé au label
    Description
    Retourne le texte.
    Retourne
    string
  • setText(text) — Spécifie le texte associé au label
    Description
    Spécifie le texte.
  • getFont() — Récupère la police associé au label
    Description
    La police implémente l'interface BCGFont.
    Retourne
    BCGFont
  • setFont(font) — Spécifie la police associée au label
    Description
    Supporte deux sortes de police.
    - BCGFontFile : Police TTF
    - BCGFontPhp : Police intégrée à PHP
    La valeur par défaut est BCGFontPhp(5).
  • getPosition() — Récupère la position associée au label
    Description
    Voyez aussi setPosition() pour plus de détails.
    Retourne
    int
  • setPosition(position) — Spécifie la position associé au label
    Description
    Les valeurs possibles pour cet argument sont :
    BCGLabel.POSITION_TOP : Écrit le label en haut du code-barres
    BCGLabel.POSITION_RIGHT : Écrit le label à droite du code-barres
    BCGLabel.POSITION_BOTTOM : Écrit le label en bas du code-barres
    BCGLabel.POSITION_LEFT : Écrit le label à gauche du code-barres
    Notez que le texte ne sera pas pivoté par défaut si celui-ci est placé sur la gauche ou la droite. Afin de faire pivoter le code-barres, vous devez utiliser la méthode setRotationAngle().
    La valeur par défaut est BCGLabel.POSITION_BOTTOM.
  • getAlignment() — Récupère l'alignment associé au label
    Description
    Voyez aussi setAlignment() pour plus de détails.
    Retourne
    int
  • setAlignment(alignment) — Spécifie l'alignement associé au label
    Description
    Les valeurs possibles pour cet argument sont :
    BCGLabel.ALIGN_LEFT : Aligne le label sur la gauche du code-barres
    BCGLabel.ALIGN_RIGHT : Aligne le label sur la droite du code-barres
    BCGLabel.ALIGN_CENTER : Aligne le label au centre du code-barres
    BCGLabel.ALIGN_TOP : Aligne le label sur le haut du code-barres
    BCGLabel.ALIGN_BOTTOM : Aligne le label sur le bas du code-barres
    Utilisez BCGLabel.ALIGN_LEFT et BCGLabel.ALIGN_RIGHT pour aligner sur la gauche ou droite, pour du texte positionné en haut ou en bas, indépendamment de l'angle de rotation. Par conséquent, utilisez BCGLabel.ALIGN_TOP et BCGLabel.ALIGN_BOTTOM pour aligner en haut ou bas, pour du texte positionné sur la gauche ou sur la droite.
    La valeur par défaut est BCGLabel.ALIGN_CENTER.
  • getOffset() — Récupère le décalage associé au label
    Description
    Récupère le décalage en pixel associé au label.
    Retourne
    int
  • setOffset(offset) — Spécifie le décalage associé au label
    Description
    Spécifie le décalage en pixel associé au label.
    Un décalage positif déplacera le texte vers la droite pour du texte positionné en haut ou en bas, et déplacera le texte vers le bas pour du texte positionné à gauche ou à droite.
    Vous pouvez utiliser un chiffre négatif pour avoir le rendu inverse.
    La valeur par défaut est 0.
  • getSpacing() — Récupère l'espace associé au label
    Description
    Récupère l'espace entre le label et le code-barres en pixel.
    Retourne
    int
  • setSpacing(spacing) — Spécifie l'espace associé au label
    Description
    Spécifie l'espace entre le label et le code-barres en pixel.
    Pour un texte positionné en haut ou en bas, ceci est la distance entre la partie du bas et la partie du haut du texte.
    Pour un texte positionné à gauche et à droite, ceci est la distance entre la partie du droite et la partie gauche du texte.
    La valeur par défaut est 4.
  • getRotationAngle() — Récupère l'angle de rotation associé au label
    Description
    Récupère l'angle de rotation en degré dans le sens des aiguilles d'une montre.
    Retourne
    int
  • setRotationAngle(rotationAngle) — Spécifie l'angle de rotation associé au label
    Description
    Spécifie l'angle de rotation en degré dans le sens des aiguilles d'une montre. Les valeurs possibles pour cet argument sont :
    - 0: Par défaut, aucune rotation n'est appliquée
    - 90: Pivote le texte 90° dans le sens des aiguilles d'une montre
    - 180: Pivote le texte 180° dans le sens des aiguilles d'une montre
    - 270: Pivote le texte 270° dans le sens des aiguilles d'une montre
    La valeur par défaut est 0.
    Notez que votre serveur peut ne pas supporter la fonction imagerotate().
  • getBackgroundColor() — Récupère la couleur de fond associée avec le label
    Description
    Récupère la couleur de fond.
    Retourne
  • setBackgroundColor(backgroundColor) — Spécifie la couleur de fond associée avec le label
    Description
    Spécifie la couleur de fond, utillisée pour la rotation.
    Cette méthode est interne; n'utilisez pas cette méthode directement.
  • getDimension() — Récupère les dimensions du texte
    Description
    Récupère la largeur et la hauteur en pixel en fonction de la police et du texte entré.
    Retourne
    array(int, int) - [0] étant la largeur, [1] étant la hauteur
  • draw(im, x1, y1, x2, y2) — Dessine le texte sur l'image
    Description
    image est une image ressource.
    Les arguments x1 et y1 correspondent à la position du coin supérieur gauche du code-barres.
    Les arguments x2 et y2 correspondent à la position du coin inférieur droit du code-barres.