1 /* 2 =================== DO NOT EDIT THIS FILE ==================== 3 Generated by Modello 1.4.1 on 2013-11-14 22:17:21, 4 any modifications will be overwritten. 5 ============================================================== 6 */ 7 8 package org.apache.maven.doxia.document; 9 10 /** 11 * Specifies the default behavior for hyperlinks in the document. 12 * 13 * @version $Revision$ $Date$ 14 */ 15 @SuppressWarnings( "all" ) 16 public class DocumentHyperlinkBehaviour 17 implements java.io.Serializable 18 { 19 20 //--------------------------/ 21 //- Class/Member Variables -/ 22 //--------------------------/ 23 24 /** 25 * 26 * The name of the default target frame. 27 * <p> 28 * Specifies the name of the default target frame 29 * in which to display 30 * a document referenced by a hyperlink. 31 * </p> 32 * 33 * <p> 34 * This attribute can have one of the following 35 * values: 36 * </p> 37 * 38 * <dl> 39 * <dd>_self</dd> 40 * <dt> 41 * The referenced document replaces the content 42 * of the current frame. 43 * </dt> 44 * 45 * <dd>_blank</dd> 46 * <dt> 47 * The referenced document is displayed in a 48 * new frame. 49 * </dt> 50 * 51 * <dd>_parent</dd> 52 * <dt> 53 * The referenced document is displayed in the 54 * parent frame 55 * of the current frame. 56 * </dt> 57 * 58 * <dd>_top</dd> 59 * <dt> 60 * The referenced document is displayed in the 61 * topmost frame, 62 * that is the frame that contains the current 63 * frame as a child 64 * or descendent but is not contained within 65 * another frame. 66 * </dt> 67 * 68 * <dd>A frame name</dd> 69 * <dt> 70 * The referenced document is displayed in the 71 * named frame. 72 * If the named frame does not exist, a new 73 * frame with that 74 * name is created. 75 * </dt> 76 * </dl> 77 * 78 */ 79 private String targetFrame = "_self"; 80 81 82 //-----------/ 83 //- Methods -/ 84 //-----------/ 85 86 /** 87 * Method equals. 88 * 89 * @param other 90 * @return boolean 91 */ 92 public boolean equals( Object other ) 93 { 94 if ( this == other ) 95 { 96 return true; 97 } 98 99 if ( !( other instanceof DocumentHyperlinkBehaviour ) ) 100 { 101 return false; 102 } 103 104 DocumentHyperlinkBehaviour that = (DocumentHyperlinkBehaviour) other; 105 boolean result = true; 106 107 result = result && ( getTargetFrame() == null ? that.getTargetFrame() == null : getTargetFrame().equals( that.getTargetFrame() ) ); 108 109 return result; 110 } //-- boolean equals( Object ) 111 112 /** 113 * Get the name of the default target frame. 114 * <p> 115 * Specifies the name of the default target frame 116 * in which to display 117 * a document referenced by a hyperlink. 118 * </p> 119 * 120 * <p> 121 * This attribute can have one of the following 122 * values: 123 * </p> 124 * 125 * <dl> 126 * <dd>_self</dd> 127 * <dt> 128 * The referenced document replaces the content 129 * of the current frame. 130 * </dt> 131 * 132 * <dd>_blank</dd> 133 * <dt> 134 * The referenced document is displayed in a 135 * new frame. 136 * </dt> 137 * 138 * <dd>_parent</dd> 139 * <dt> 140 * The referenced document is displayed in the 141 * parent frame 142 * of the current frame. 143 * </dt> 144 * 145 * <dd>_top</dd> 146 * <dt> 147 * The referenced document is displayed in the 148 * topmost frame, 149 * that is the frame that contains the current 150 * frame as a child 151 * or descendent but is not contained within 152 * another frame. 153 * </dt> 154 * 155 * <dd>A frame name</dd> 156 * <dt> 157 * The referenced document is displayed in the 158 * named frame. 159 * If the named frame does not exist, a new 160 * frame with that 161 * name is created. 162 * </dt> 163 * </dl> 164 * 165 * @return String 166 */ 167 public String getTargetFrame() 168 { 169 return this.targetFrame; 170 } //-- String getTargetFrame() 171 172 /** 173 * Method hashCode. 174 * 175 * @return int 176 */ 177 public int hashCode() 178 { 179 int result = 17; 180 181 result = 37 * result + ( targetFrame != null ? targetFrame.hashCode() : 0 ); 182 183 return result; 184 } //-- int hashCode() 185 186 /** 187 * Set the name of the default target frame. 188 * <p> 189 * Specifies the name of the default target frame 190 * in which to display 191 * a document referenced by a hyperlink. 192 * </p> 193 * 194 * <p> 195 * This attribute can have one of the following 196 * values: 197 * </p> 198 * 199 * <dl> 200 * <dd>_self</dd> 201 * <dt> 202 * The referenced document replaces the content 203 * of the current frame. 204 * </dt> 205 * 206 * <dd>_blank</dd> 207 * <dt> 208 * The referenced document is displayed in a 209 * new frame. 210 * </dt> 211 * 212 * <dd>_parent</dd> 213 * <dt> 214 * The referenced document is displayed in the 215 * parent frame 216 * of the current frame. 217 * </dt> 218 * 219 * <dd>_top</dd> 220 * <dt> 221 * The referenced document is displayed in the 222 * topmost frame, 223 * that is the frame that contains the current 224 * frame as a child 225 * or descendent but is not contained within 226 * another frame. 227 * </dt> 228 * 229 * <dd>A frame name</dd> 230 * <dt> 231 * The referenced document is displayed in the 232 * named frame. 233 * If the named frame does not exist, a new 234 * frame with that 235 * name is created. 236 * </dt> 237 * </dl> 238 * 239 * @param targetFrame 240 */ 241 public void setTargetFrame( String targetFrame ) 242 { 243 this.targetFrame = targetFrame; 244 } //-- void setTargetFrame( String ) 245 246 /** 247 * Method toString. 248 * 249 * @return String 250 */ 251 public java.lang.String toString() 252 { 253 StringBuilder buf = new StringBuilder( 128 ); 254 255 buf.append( "targetFrame = '" ); 256 buf.append( getTargetFrame() ); 257 buf.append( "'" ); 258 259 return buf.toString(); 260 } //-- java.lang.String toString() 261 262 }