com.openhtmltopdf.css.sheet.PropertyDeclaration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openhtmltopdf-core Show documentation
Show all versions of openhtmltopdf-core Show documentation
Open HTML to PDF is a CSS 2.1 renderer written in Java. This artifact contains the core rendering and layout code.
/*
* PropertyDeclaration.java
* Copyright (c) 2004, 2005 Torbjoern Gannholm, Patrick Wright
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
package com.openhtmltopdf.css.sheet;
import com.openhtmltopdf.css.constants.CSSName;
import com.openhtmltopdf.css.constants.IdentValue;
import com.openhtmltopdf.css.parser.CSSPrimitiveValue;
import com.openhtmltopdf.css.parser.CSSValue;
import com.openhtmltopdf.css.parser.PropertyValue;
/**
* Represents a single property declared in a CSS rule set. A
* PropertyDeclaration is created from an CSSValue and is immutable. The
* declaration knows its origin, importance and specificity, and thus is
* prepared to be sorted out among properties of the same name, within a matched
* group, for the CSS cascade, into a {@link
* com.openhtmltopdf.css.newmatch.CascadedStyle}.
*
* @author Torbjoern Gannholm
* @author Patrick Wright
*/
public class PropertyDeclaration {
/**
* Description of the Field
*/
private CSSName cssName;
/**
* Description of the Field
*/
private CSSPrimitiveValue cssPrimitiveValue;
/**
* Whether the property was declared as important! by the user.
*/
private boolean important;
/**
* Origin constant from the list defined in {@link Stylesheet}. See {@link
* Stylesheet#USER_AGENT}, {@link StylesheetInfo#USER}, and {@link
* Stylesheet#AUTHOR}.
*/
private int origin;
/**
* Description of the Field
*/
private IdentValue _identVal;
/**
* Description of the Field
*/
private boolean identIsSet;
private String _fingerprint;
/**
* ImportanceAndOrigin of stylesheet - how many different
*/
public final static int IMPORTANCE_AND_ORIGIN_COUNT = 6;
/**
* ImportanceAndOrigin of stylesheet - user agent
*/
private final static int USER_AGENT = 1;
/**
* ImportanceAndOrigin of stylesheet - user normal
*/
private final static int USER_NORMAL = 2;
/**
* ImportanceAndOrigin of stylesheet - author normal
*/
private final static int AUTHOR_NORMAL = 3;
/**
* ImportanceAndOrigin of stylesheet - author important
*/
private final static int AUTHOR_IMPORTANT = 4;
/**
* ImportanceAndOrigin of stylesheet - user important
*/
private final static int USER_IMPORTANT = 5;
/**
* Creates a new instance of PropertyDeclaration from an {@link
* CSSPrimitiveValue} instance.
*
* @param cssName
* @param value The CSSValue to wrap
* @param imp True if property was declared important! and false if
* not.
* @param orig int constant from {@link Stylesheet} for the origin of
* the property declaration, that is, the origin of the style sheet
* where it was declared. See {@link StylesheetInfo#USER_AGENT}, {@link
* StylesheetInfo#USER}, and {@link StylesheetInfo#AUTHOR}.
*/
public PropertyDeclaration(CSSName cssName,
CSSPrimitiveValue value,
boolean imp,
int orig) {
this.cssName = cssName;
this.cssPrimitiveValue = value;
this.important = imp;
this.origin = orig;
}
/**
* Converts to a String representation of the object.
*
* @return A string representation of the object.
*/
@Override
public String toString() {
return getPropertyName() + ": " + getValue().toString();
}
/**
* Description of the Method
*
* @return Returns
*/
public IdentValue asIdentValue() {
if (!identIsSet) {
_identVal = IdentValue.getByIdentString(cssPrimitiveValue.getCssText());
identIsSet = true;
}
return _identVal;
}
public String getDeclarationStandardText() {
return cssName + ": " + cssPrimitiveValue.getCssText() + ";";
}
public String getFingerprint() {
if (_fingerprint == null) {
_fingerprint = 'P' + cssName.FS_ID + ':' + ((PropertyValue)cssPrimitiveValue).getFingerprint() + ';';
}
return _fingerprint;
}
/**
* Returns an int representing the combined origin and importance of the
* property as declared. The int is assigned such that default origin and
* importance is 0, and highest an important! property defined by the user
* (origin is Stylesheet.USER). The combined value would allow this property
* to be sequenced in the CSS cascade along with other properties matched to
* the same element with the same property name. In that sort, the highest
* sequence number returned from this method would take priority in the
* cascade, so that a user important! property would override a user
* non-important! property, and so on. The actual integer value returned by
* this method is unimportant, but has a lowest value of 0 and increments
* sequentially by 1 for each increase in origin/importance..
*
* @return See method javadoc.
*/
public int getImportanceAndOrigin() {
if (origin == StylesheetInfo.USER_AGENT) {
return PropertyDeclaration.USER_AGENT;
} else if (origin == StylesheetInfo.USER) {
if (important) {
return PropertyDeclaration.USER_IMPORTANT;
}
return PropertyDeclaration.USER_NORMAL;
} else {
if (important) {
return PropertyDeclaration.AUTHOR_IMPORTANT;
}
return PropertyDeclaration.AUTHOR_NORMAL;
}
}
/**
* Returns the CSS name of this property, e.g. "font-family".
*
* @return See desc.
*/
public String getPropertyName() {
return this.cssName.toString();
}
/**
* Gets the cSSName attribute of the PropertyDeclaration object
*
* @return The cSSName value
*/
public CSSName getCSSName() {
return cssName;
}
/**
* Returns the specified {@link CSSValue} for this property.
* Specified means the value as entered by the user. Modifying the CSSValue
* returned here will result in indeterminate behavior--consider it
* immutable.
*
* @return See desc.
*/
public CSSPrimitiveValue getValue() {
return cssPrimitiveValue;
}
public boolean isImportant() {
return important;
}
public int getOrigin() {
return origin;
}
public void toCSS(StringBuilder sb) {
sb.append(getPropertyName());
sb.append(':');
sb.append(' ');
sb.append(getValue().toString());
if (isImportant()) {
sb.append(" !important;");
} else {
sb.append(';');
}
}
}// end class
/*
* $Id$
*
* $Log$
* Revision 1.21 2007/05/21 21:47:30 peterbrant
* Final CSS clean up
*
* Revision 1.20 2007/02/20 17:23:14 peterbrant
* Optimize fingerprint calculation
*
* Revision 1.19 2007/02/19 14:53:37 peterbrant
* Integrate new CSS parser
*
* Revision 1.18 2006/07/28 10:08:56 pdoubleya
* Additional work for support of parsing content and quotes.
*
* Revision 1.17 2005/12/28 00:50:53 peterbrant
* Continue ripping out first try at pagination / Minor method name refactoring
*
* Revision 1.16 2005/10/24 10:19:40 pdoubleya
* CSSName FS_ID is now public and final, allowing direct access to the id, bypassing getAssignedID(); micro-optimization :); getAssignedID() and setAssignedID() have been removed. IdentValue string property is also final (as should have been).
*
* Revision 1.15 2005/06/19 23:02:38 tobega
* Implemented calculation of minimum cell-widths.
* Implemented border-spacing.
*
* Revision 1.14 2005/06/15 17:27:37 pdoubleya
* Allow for custom properties (don't break).
*
* Revision 1.13 2005/05/08 15:37:27 tobega
* Fixed up style caching so it really works (internalize CascadedStyles and let each CalculatedStyle keep track of its derived children)
*
* Revision 1.12 2005/01/29 20:19:21 pdoubleya
* Clean/reformat code. Removed commented blocks, checked copyright.
*
* Revision 1.11 2005/01/29 16:02:30 pdoubleya
* Fixed case where null CSS name is passed for a PD factory; this is valid on testing (use default factory).
*
* Revision 1.10 2005/01/29 12:07:37 pdoubleya
* Changed to use array for PD factories.
*
* Revision 1.9 2005/01/25 14:45:56 pdoubleya
* Added support for IdentValue mapping on property declarations. On both CascadedStyle and PropertyDeclaration you can now request the value as an IdentValue, for object-object comparisons. Updated 99% of references that used to get the string value of PD to return the IdentValue instead; remaining cases are for pseudo-elements where the PD content needs to be manipulated as a String.
*
* Revision 1.8 2005/01/24 19:01:08 pdoubleya
* Mass checkin. Changed to use references to CSSName, which now has a Singleton instance for each property, everywhere property names were being used before. Removed commented code. Cascaded and Calculated style now store properties in arrays rather than maps, for optimization.
*
* Revision 1.7 2005/01/24 14:54:32 pdoubleya
* Removed references to XRProperty (unused).
*
* Revision 1.6 2005/01/24 14:36:30 pdoubleya
* Mass commit, includes: updated for changes to property declaration instantiation, and new use of DerivedValue. Removed any references to older XR... classes (e.g. XRProperty). Cleaned imports.
*
* Revision 1.5 2004/12/11 18:18:07 tobega
* Still broken, won't even compile at the moment. Working hard to fix it, though. Replace the StyleReference interface with our only concrete implementation, it was a bother changing in two places all the time.
*
* Revision 1.4 2004/11/28 23:29:01 tobega
* Now handles media on Stylesheets, still need to handle at-media-rules. The media-type should be set in Context.media (set by default to "screen") before calling setContext on StyleReference.
*
* Revision 1.3 2004/11/16 10:39:34 pdoubleya
* Made members all private where appropriate.
* Comments.
*
* Revision 1.2 2004/11/15 12:42:23 pdoubleya
* Across this checkin (all may not apply to this particular file)
* Changed default/package-access members to private.
* Changed to use XRRuntimeException where appropriate.
* Began move from System.err.println to std logging.
* Standard code reformat.
* Removed some unnecessary SAC member variables that were only used in initialization.
* CVS log section.
*
*
*/