View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.trinidad.style;
20  
21  import java.util.Map;
22  
23  /**
24   * A Style object defines a set of visual (or aural) style properties.
25   * The Style interface exposes one method for retrieving properties:
26   * getProperties().  
27   * getProperties() returns a Map<String, String> of the propery name as the
28   * key and the property value as the value.
29   *
30   */
31  public abstract class Style
32  {
33  
34    /**
35     * Returns an unmodifiable Map of the properties (name/value) 
36     * defined by this style.
37     */
38    abstract public Map<String, String> getProperties();
39  
40  
41    /**
42     * Converts the style to a String suitable for use as an inline style
43     * attribute value.
44     */
45    abstract public String toInlineString();
46  
47  }
48