KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > dspace > app > mediafilter > BrandText


1 /*
2  * BrandText.java
3  *
4  * Version: $Revision: 1.1 $
5  *
6  * Date: $Date: 2006/03/10 20:30:03 $
7  *
8  * Copyright (c) 2002-2006, Hewlett-Packard Company and Massachusetts
9  * Institute of Technology. All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are
13  * met:
14  *
15  * - Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  *
18  * - Redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution.
21  *
22  * - Neither the name of the Hewlett-Packard Company nor the name of the
23  * Massachusetts Institute of Technology nor the names of their
24  * contributors may be used to endorse or promote products derived from
25  * this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
34  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38  * DAMAGE.
39  */
40 package org.dspace.app.mediafilter;
41
42 /**
43  * Identifier class, holding a single item of text and its location
44  * within a rectangular areas. Allowable locations are any of the four corners.
45  * This is a copy of Picture Australia's PiObj class re-organised with methods.
46  * Thanks to Ninh Nguyen at the National Library for providing the original source.
47  */
48 class BrandText
49 {
50     /** Bottom Left */
51     public static final String JavaDoc BL = "bl";
52     /** Bottom Right */
53     public static final String JavaDoc BR = "br";
54     /** Top Left */
55     public static final String JavaDoc TL = "tl";
56     /** Top Right */
57     public static final String JavaDoc TR = "tr";
58
59     private String JavaDoc location;
60     private String JavaDoc text;
61
62     /**
63      * Constructor for an Identifier object containing a text string and
64      * its location within a rectangular area.
65      *
66      * @param location one of the class location constants e.g. <code>Identifier.BL</code>
67      * @param the text associated with the location
68      */
69     public BrandText(String JavaDoc location, String JavaDoc text)
70     {
71         this.location = location;
72         this.text = text;
73     }
74
75     /**
76      * get the location the text of the Identifier object is associated with
77      *
78      * @return String one the class location constants e.g. <code>Identifier.BL</code>
79      */
80     public String JavaDoc getLocation()
81     {
82         return location;
83     }
84
85
86     /**
87      * get the text associated with the Identifier object
88      *
89      * @return String the text associated with the Identifier object
90      */
91     public String JavaDoc getText()
92     {
93         return text;
94     }
95
96
97     /**
98      * set the location associated with the Identifier object
99      *
100      * @param location one of the class location constants
101      */
102     public void setLocation(String JavaDoc location)
103     {
104         this.location = location;
105     }
106
107
108     /**
109      * set the text associated with the Identifier object
110      *
111      * @param text any text string (typically a branding or identifier)
112      */
113     public void setText(String JavaDoc text)
114     {
115         this.text = text;
116     }
117 }
118
Popular Tags