View Javadoc

1   /*
2    * $Id: IBackgroundImageCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3    */
4   package org.rcfaces.core.component.capability;
5   
6   /**
7    * Everything concerning background image.
8    * 
9    * 
10   * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
11   * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
12   */
13  public interface IBackgroundImageCapability {
14  
15      /**
16       * Returns an url string pointing to the background image.
17       * 
18       * @return image url
19       */
20      String getBackgroundImageURL();
21  
22      /**
23       * Sets an url string pointing to the background image.
24       * 
25       * @param backgroundImageURL
26       *            image url
27       */
28      void setBackgroundImageURL(String backgroundImageURL);
29  
30      /**
31       * Returns a string indicating the horizontal positionning for the
32       * background image.
33       * 
34       * @return horizontal position
35       */
36      String getBackgroundImageHorizontalPosition();
37  
38      /**
39       * Sets a string indicating the horizontal positionning for the background
40       * image.
41       * 
42       * @param horizontalPosition
43       *            horizontal position
44       */
45      void setBackgroundImageHorizontalPosition(String horizontalPosition);
46  
47      /**
48       * Returns a string indicating the vertical positionning for the background
49       * image.
50       * 
51       * @return vertical position
52       */
53      String getBackgroundImageVerticalPosition();
54  
55      /**
56       * Sets a string indicating the vertical positionning for the background
57       * image.
58       * 
59       * @param verticalPosition
60       *            position
61       */
62      void setBackgroundImageVerticalPosition(String verticalPosition);
63  
64      /**
65       * Returns a boolean value indicating wether the background image should be
66       * repeated horizontally or not.
67       * 
68       * @return repeat
69       */
70      boolean isBackgroundImageHorizontalRepeat();
71  
72      /**
73       * Sets a boolean value indicating wether the background image should be
74       * repeated horizontally or not.
75       * 
76       * @param repeat
77       *            boolean
78       */
79      void setBackgroundImageHorizontalRepeat(boolean repeat);
80  
81      /**
82       * Returns a boolean value indicating wether the background image should be
83       * repeated vertically or not.
84       * 
85       * @return repeat
86       */
87      boolean isBackgroundImageVerticalRepeat();
88  
89      /**
90       * Sets a boolean value indicating wether the background image should be
91       * repeated vertically or not.
92       * 
93       * @param repeat
94       *            boolean
95       */
96      void setBackgroundImageVerticalRepeat(boolean repeat);
97  }