KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > area > OffDocumentExtensionAttachment


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 /* $Id: OffDocumentExtensionAttachment.java 426576 2006-07-28 15:44:37Z jeremias $ */
19
20 package org.apache.fop.area;
21
22 import org.apache.fop.fo.extensions.ExtensionAttachment;
23
24 /**
25  * This class wraps ExtensionAttachments which cannot be transported inside the area tree but
26  * need to be handled in the AreaTreeHandler. These attachments are schedules for processing
27  * before the first page-sequence, i.e. at the start of the document.
28  */
29 public class OffDocumentExtensionAttachment implements OffDocumentItem {
30
31     private ExtensionAttachment attachment;
32     
33     /**
34      * Main constructor
35      * @param attachment the extension attachment to wrap.
36      */
37     public OffDocumentExtensionAttachment(ExtensionAttachment attachment) {
38         this.attachment = attachment;
39     }
40     
41     /** @return the extension attachment. */
42     public ExtensionAttachment getAttachment() {
43         return this.attachment;
44     }
45
46     /** @see org.apache.fop.area.OffDocumentItem#getWhenToProcess() */
47     public int getWhenToProcess() {
48         return OffDocumentItem.IMMEDIATELY;
49     }
50
51     /** @see org.apache.fop.area.OffDocumentItem#getName() */
52     public String JavaDoc getName() {
53         return attachment.getCategory();
54     }
55     
56 }
57
Popular Tags