com.itextpdf.styledxmlparser.css.media.MediaFeature Maven / Gradle / Ivy

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.styledxmlparser.css.media;

/**
 * Class that bundles all the media feature values.
 */
public final class MediaFeature {

    /**
     * Creates a new {@link MediaFeature} instance.
     */
    private MediaFeature() {
    }

    /**
     * Value: <integer>

     * Media: visual

     * Accepts min/max prefixes: yes

     * Indicates the number of bits per color component of the output device. If the device is not a color device, this value is zero.
     */
    public static final String COLOR = "color";

    /**
     * Value: <integer>

     * Media: visual

     * Accepts min/max prefixes: yes

     * Indicates the number of entries in the color look-up table for the output device.
     */
    public static final String COLOR_INDEX = "color-index";

    /**
     * Value: <ratio>

     * Media: visual, tactile

     * Accepts min/max prefixes: yes

     * Describes the aspect ratio of the targeted display area of the output device.
     * This value consists of two positive integers separated by a slash ("/") character.
     * This represents the ratio of horizontal pixels (first term) to vertical pixels (second term).
     */
    public static final String ASPECT_RATIO = "aspect-ratio";

    /**
     * Value: <mq-boolean> which is an <integer> that can only have the 0 and 1 value.

     * Media: all

     * Accepts min/max prefixes: no

     * Determines whether the output device is a grid device or a bitmap device.
     * If the device is grid-based (such as a TTY terminal or a phone display with only one font),
     * the value is 1. Otherwise it is zero.
     */
    public static final String GRID = "grid";

    /**
     * Value: progressive | interlace

     * Media: tv

     * Accepts min/max prefixes: no

     * Describes the scanning process of television output devices.
     */
    public static final String SCAN = "scan";

    /**
     * Value: landscape | portrait

     * Media: visual

     * Accepts min/max prefixes: no

     * Indicates whether the viewport is in landscape (the display is wider than it is tall) or
     * portrait (the display is taller than it is wide) mode.
     */
    public static final String ORIENTATION = "orientation";

    /**
     * Value: <integer>

     * Media: visual

     * Accepts min/max prefixes: yes

     * Indicates the number of bits per pixel on a monochrome (greyscale) device.
     * If the device isn't monochrome, the device's value is 0.
     */
    public static final String MONOCHROME = "monochrome";

    /**
     * Value: <length>

     * Media: visual, tactile

     * Accepts min/max prefixes: yes

     * The height media feature describes the height of the output device's rendering surface
     * (such as the height of the viewport or of the page box on a printer).
     */
    public static final String HEIGHT = "height";

    /**
     * Value: <resolution>

     * Media: bitmap

     * Accepts min/max prefixes: yes

     * Indicates the resolution (pixel density) of the output device. The resolution may be specified in
     * either dots per inch (dpi) or dots per centimeter (dpcm).
     */
    public static final String RESOLUTION = "resolution";

    /**
     * Value: <length>

     * Media: visual, tactile

     * Accepts min/max prefixes: yes

     * The width media feature describes the width of the rendering surface of the output device
     * (such as the width of the document window, or the width of the page box on a printer).
     */
    public static final String WIDTH = "width";


}