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