xml-apis/xml-apis/1.4.01 : org/w3c/css/sac/LexicalUnit.java

LexicalUnit
http://xml.apache.org/commons/components/external/: xml-commons provides an Apache-hosted set of DOM, SAX, and JAXP interfaces for use in other xml-based projects. Our hope is that we can standardize on both a common version and packaging scheme for these critical XML standards interfaces to make the lives of both our developers and users easier. The External Components portion of xml-commons contains interfaces that are defined by external standards organizations. For DOM, that's the W3C; for SAX it's David Megginson and sax.sourceforge.net; for JAXP it's Sun.
Apache Software Foundation (Apache Software Foundation)
/*
 * Copyright (c) 1999 World Wide Web Consortium
 * (Massachusetts Institute of Technology, Institut National de Recherche
 *  en Informatique et en Automatique, Keio University).
 * All Rights Reserved. http://www.w3.org/Consortium/Legal/
 *
 * $Id: LexicalUnit.java 477010 2006-11-20 02:54:38Z mrglavas $
 */
package org.w3c.css.sac;

This is a lexical unit for CSS values.
Remarks: Not all the following lexical units are supported (or
will be supported) by CSS.
All examples are CSS2 compliant.
Author: Philippe Le Hegaret
Version: $Revision: 477010 $/**
 * This is a lexical unit for CSS values.
 * <p><b>Remarks</b>: Not all the following lexical units are supported (or
 * will be supported) by CSS.
 * <p>All examples are CSS2 compliant.
 *
 * @version $Revision: 477010 $
 * @author Philippe Le Hegaret
 */
public interface LexicalUnit {
    
    ,
/**
     * ,
     */
    public static final short SAC_OPERATOR_COMMA	= 0;
    +
/**
     * +
     */
    public static final short SAC_OPERATOR_PLUS		= 1;
    -
/**
     * -
     */
    public static final short SAC_OPERATOR_MINUS	= 2;
     *
/**
     * *
     */
    public static final short SAC_OPERATOR_MULTIPLY	= 3;
    /
/**
     * /
     */
    public static final short SAC_OPERATOR_SLASH	= 4;
    %
/**
     * %
     */
    public static final short SAC_OPERATOR_MOD		= 5;
    ^
/**
     * ^
     */
    public static final short SAC_OPERATOR_EXP		= 6;
    <
/**
     * <
     */
    public static final short SAC_OPERATOR_LT		= 7;
    >
/**
     * >
     */
    public static final short SAC_OPERATOR_GT		= 8;
    <=
/**
     * <=
     */
    public static final short SAC_OPERATOR_LE		= 9;
    >=
/**
     * >=
     */
    public static final short SAC_OPERATOR_GE		= 10;
    ~
/**
     * ~
     */
    public static final short SAC_OPERATOR_TILDE	= 11;
    
    identifier inherit.
/**
     * identifier <code>inherit</code>.
     */
    public static final short SAC_INHERIT		= 12;
    Integers.
See Also: getIntegerValue/**
     * Integers.
     * @see #getIntegerValue
     */
    public static final short SAC_INTEGER		= 13;
    reals.
See Also: getFloatValue
getDimensionUnitText/**
     * reals.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_REAL		        = 14;
    Relative lengthem.
See Also: getFloatValue
getDimensionUnitText/**
     * Relative length<code>em</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_EM		= 15;
    Relative lengthex.
See Also: getFloatValue
getDimensionUnitText/**
     * Relative length<code>ex</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_EX		= 16;
    Relative length px.
See Also: getFloatValue
getDimensionUnitText/**
     * Relative length <code>px</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_PIXEL		= 17;
    Absolute length in.
See Also: getFloatValue
getDimensionUnitText/**
     * Absolute length <code>in</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_INCH		= 18;
    Absolute length cm.
See Also: getFloatValue
getDimensionUnitText/**
     * Absolute length <code>cm</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_CENTIMETER	= 19;
    Absolute length mm.
See Also: getFloatValue
getDimensionUnitText/**
     * Absolute length <code>mm</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_MILLIMETER	= 20;
    Absolute length pt.
See Also: getFloatValue
getDimensionUnitText/**
     * Absolute length <code>pt</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_POINT		= 21;
    Absolute length pc.
See Also: getFloatValue
getDimensionUnitText/**
     * Absolute length <code>pc</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_PICA		= 22;
    Percentage.
See Also: getFloatValue
getDimensionUnitText/**
     * Percentage.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_PERCENTAGE		= 23;
    URI: uri(...).
See Also: getStringValue/**
     * URI: <code>uri(...)</code>.
     * @see #getStringValue
     */
    public static final short SAC_URI		        = 24;
    function counter.
See Also: getFunctionName
getParameters/**
     * function <code>counter</code>.
     * @see #getFunctionName
     * @see #getParameters
     */
    public static final short SAC_COUNTER_FUNCTION	= 25;
    function counters.
See Also: getFunctionName
getParameters/**
     * function <code>counters</code>.
     * @see #getFunctionName
     * @see #getParameters
     */
    public static final short SAC_COUNTERS_FUNCTION	= 26;
    RGB Colors.
rgb(0, 0, 0) and #000
See Also: getFunctionName
getParameters/**
     * RGB Colors.
     * <code>rgb(0, 0, 0)</code> and <code>#000</code>
     * @see #getFunctionName
     * @see #getParameters
     */
    public static final short SAC_RGBCOLOR		= 27;
    Angle deg.
See Also: getFloatValue
getDimensionUnitText/**
     * Angle <code>deg</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_DEGREE		= 28;
    Angle grad.
See Also: getFloatValue
getDimensionUnitText/**
     * Angle <code>grad</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_GRADIAN		= 29;
    Angle rad.
See Also: getFloatValue
getDimensionUnitText/**
     * Angle <code>rad</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_RADIAN		= 30;
    Time ms.
See Also: getFloatValue
getDimensionUnitText/**
     * Time <code>ms</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_MILLISECOND		= 31;
    Time s.
See Also: getFloatValue
getDimensionUnitText/**
     * Time <code>s</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_SECOND		= 32;
    Frequency Hz.
See Also: getFloatValue
getDimensionUnitText/**
     * Frequency <code>Hz</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_HERTZ		        = 33;
    Frequency kHz.
See Also: getFloatValue
getDimensionUnitText/**
     * Frequency <code>kHz</code>.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_KILOHERTZ		= 34;
    
    any identifier except inherit.
See Also: getStringValue/**
     * any identifier except <code>inherit</code>.
     * @see #getStringValue
     */
    public static final short SAC_IDENT		        = 35;
    A string.
See Also: getStringValue/**
     * A string.
     * @see #getStringValue
     */
    public static final short SAC_STRING_VALUE		= 36;
    Attribute: attr(...).
See Also: getStringValue/**
     * Attribute: <code>attr(...)</code>.
     * @see #getStringValue
     */
    public static final short SAC_ATTR		        = 37;
    function rect.
See Also: getFunctionName
getParameters/**
     * function <code>rect</code>.
     * @see #getFunctionName
     * @see #getParameters
     */
    public static final short SAC_RECT_FUNCTION		= 38;
    A unicode range. @@TO BE DEFINED
/**
     * A unicode range. @@TO BE DEFINED
     */
    public static final short SAC_UNICODERANGE		= 39;
    
    sub expressions
(a) (a + b) (normal/none)
See Also: getSubValues/**
     * sub expressions
     * <code>(a)</code> <code>(a + b)</code> <code>(normal/none)</code>
     * @see #getSubValues
     */
    public static final short SAC_SUB_EXPRESSION	= 40;
    
    unknown function.
See Also: getFunctionName
getParameters/**
     * unknown function.
     * @see #getFunctionName
     * @see #getParameters
     */
    public static final short SAC_FUNCTION		= 41;
    unknown dimension.
See Also: getFloatValue
getDimensionUnitText/**
     * unknown dimension.
     * @see #getFloatValue
     * @see #getDimensionUnitText
     */
    public static final short SAC_DIMENSION		= 42;
    
    An integer indicating the type of LexicalUnit.
/**
     * An integer indicating the type of <code>LexicalUnit</code>.
     */
    public short       getLexicalUnitType();
    
    Returns the next value or null if any.
/**
     * Returns the next value or <code>null</code> if any.
     */
    public LexicalUnit getNextLexicalUnit();
    
    Returns the previous value or null if any.
/**
     * Returns the previous value or <code>null</code> if any.
     */
    public LexicalUnit getPreviousLexicalUnit();
    
    Returns the integer value.
See Also: SAC_INTEGER/**
     * Returns the integer value.
     * @see #SAC_INTEGER
     */
    public int getIntegerValue();
    
    
    Returns the float value.
If the type of LexicalUnit is one of SAC_DEGREE,
SAC_GRADIAN, SAC_RADIAN, SAC_MILLISECOND, SAC_SECOND, SAC_HERTZ
or SAC_KILOHERTZ, the value can never be negative.
See Also: SAC_REAL
SAC_DIMENSION
SAC_EM
SAC_EX
SAC_PIXEL
SAC_INCH
SAC_CENTIMETER
SAC_MILLIMETER
SAC_POINT
SAC_PICA
SAC_PERCENTAGE
SAC_DEGREE
SAC_GRADIAN
SAC_RADIAN
SAC_MILLISECOND
SAC_SECOND
SAC_HERTZ
SAC_KILOHERTZ/**
     * Returns the float value.
     * <p>If the type of <code>LexicalUnit</code> is one of SAC_DEGREE,
     * SAC_GRADIAN, SAC_RADIAN, SAC_MILLISECOND, SAC_SECOND, SAC_HERTZ
     * or SAC_KILOHERTZ, the value can never be negative.</p>
     *
     * @see #SAC_REAL
     * @see #SAC_DIMENSION
     * @see #SAC_EM
     * @see #SAC_EX
     * @see #SAC_PIXEL
     * @see #SAC_INCH
     * @see #SAC_CENTIMETER
     * @see #SAC_MILLIMETER
     * @see #SAC_POINT
     * @see #SAC_PICA
     * @see #SAC_PERCENTAGE
     * @see #SAC_DEGREE
     * @see #SAC_GRADIAN
     * @see #SAC_RADIAN
     * @see #SAC_MILLISECOND
     * @see #SAC_SECOND
     * @see #SAC_HERTZ
     * @see #SAC_KILOHERTZ
     */
    public float getFloatValue();
    
    Returns the string representation of the unit.
if this lexical unit represents a float, the dimension is an empty
string.
See Also: SAC_REAL
SAC_DIMENSION
SAC_EM
SAC_EX
SAC_PIXEL
SAC_INCH
SAC_CENTIMETER
SAC_MILLIMETER
SAC_POINT
SAC_PICA
SAC_PERCENTAGE
SAC_DEGREE
SAC_GRADIAN
SAC_RADIAN
SAC_MILLISECOND
SAC_SECOND
SAC_HERTZ
SAC_KILOHERTZ/**
     * Returns the string representation of the unit.
     * <p>if this lexical unit represents a float, the dimension is an empty
     * string.</p>
     * @see #SAC_REAL
     * @see #SAC_DIMENSION
     * @see #SAC_EM
     * @see #SAC_EX
     * @see #SAC_PIXEL
     * @see #SAC_INCH
     * @see #SAC_CENTIMETER
     * @see #SAC_MILLIMETER
     * @see #SAC_POINT
     * @see #SAC_PICA
     * @see #SAC_PERCENTAGE
     * @see #SAC_DEGREE
     * @see #SAC_GRADIAN
     * @see #SAC_RADIAN
     * @see #SAC_MILLISECOND
     * @see #SAC_SECOND
     * @see #SAC_HERTZ
     * @see #SAC_KILOHERTZ 
     */
    public String getDimensionUnitText();
    
    Returns the name of the function.
See Also: SAC_COUNTER_FUNCTION
SAC_COUNTERS_FUNCTION
SAC_RECT_FUNCTION
SAC_FUNCTION
SAC_RGBCOLOR/**
     * Returns the name of the function.
     * @see #SAC_COUNTER_FUNCTION
     * @see #SAC_COUNTERS_FUNCTION
     * @see #SAC_RECT_FUNCTION
     * @see #SAC_FUNCTION
     * @see #SAC_RGBCOLOR
     */
    public String      getFunctionName();
    
    The function parameters including operators (like the comma).
#000 is converted to rgb(0, 0, 0)
can return null if SAC_FUNCTION.
See Also: SAC_COUNTER_FUNCTION
SAC_COUNTERS_FUNCTION
SAC_RECT_FUNCTION
SAC_FUNCTION
SAC_RGBCOLOR/**
     * The function parameters including operators (like the comma).
     * <code>#000</code> is converted to <code>rgb(0, 0, 0)</code>
     * can return <code>null</code> if <code>SAC_FUNCTION</code>.
     * @see #SAC_COUNTER_FUNCTION
     * @see #SAC_COUNTERS_FUNCTION
     * @see #SAC_RECT_FUNCTION
     * @see #SAC_FUNCTION
     * @see #SAC_RGBCOLOR
     */
    public LexicalUnit getParameters();

    Returns the string value.
If the type is SAC_URI, the return value doesn't contain
uri(....) or quotes.
If the type is SAC_ATTR, the return value doesn't contain
attr(....).
See Also: SAC_URI
SAC_ATTR
SAC_IDENT
SAC_STRING_VALUE
@@TO BE DEFINED/**
     * Returns the string value.
     * <p>If the type is <code>SAC_URI</code>, the return value doesn't contain
     * <code>uri(....)</code> or quotes.
     * <p>If the type is <code>SAC_ATTR</code>, the return value doesn't contain
     * <code>attr(....)</code>.
     *
     * @see #SAC_URI
     * @see #SAC_ATTR
     * @see #SAC_IDENT
     * @see #SAC_STRING_VALUE
     * @see #SAC_UNICODERANGE @@TO BE DEFINED 
     */
    public String getStringValue();

    Returns a list of values inside the sub expression.
See Also: SAC_SUB_EXPRESSION/**
     * Returns a list of values inside the sub expression.
     * @see #SAC_SUB_EXPRESSION
     */
    public LexicalUnit getSubValues();
    
}
/

xml-apis/ xml-apis/ 1.4.01/ org/w3c/css/sac/LexicalUnit.java
