com.phloc.css.property.customizer.ICSSPropertyCustomizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-css-jdk5 Show documentation

phloc CSS parser an other components

The newest version!

/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.css.property.customizer;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.annotations.Nonempty;
import com.phloc.css.property.ICSSProperty;
import com.phloc.css.propertyvalue.ICSSValue;

/**
 * A special customizer that can be assigned to CSS properties to modify their
 * default behavior. This can be used to add browser-specific values.
 * 
 * @author Philip Helger
 */
public interface ICSSPropertyCustomizer
{
  /**
   * Create a special value for the passed property. For example if the property
   * is "border-radius" than the browser specific values like
   * "-moz-border-radius" and "-webkit-border-radius" should be emitted as well.
   * 
   * @param aProperty
   *        The CSS property the fuzz is all about. Never null.
   * @param sValue
   *        The value to be created. Neither null nor empty.
   * @param bIsImportant
   *        true if the property is important, false
   *        if not.
   * @return May be null in which case the default value is
   *         created.
   */
  @Nullable
  ICSSValue createSpecialValue (@Nonnull ICSSProperty aProperty, @Nonnull @Nonempty String sValue, boolean bIsImportant);
}