aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/fo/flow/MultiCase.java
blob: 09a854c3edc130f9cac6ad890732e9663091ca8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.fo.flow;

import org.xml.sax.Locator;

import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;

/**
 * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_multi-case">
 * <code>fo:multi-case</code></a> object.
 * TODO implement validateChildNode()
 */
public class MultiCase extends FObj {
    // The value of properties relevant for fo:multi-case.
    private int startingState;
    private String caseName;
    private String caseTitle;
    private MultiCaseHandler multiCaseHandler;
    // private ToBeImplementedProperty caseName;
    // private ToBeImplementedProperty caseTitle;
    // Unused but valid items, commented out for performance:
    //     private CommonAccessibility commonAccessibility;
    // End of property values

    /**
     * Base constructor
     *
     * @param parent {@link FONode} that is the parent of this object
     */
    public MultiCase(FONode parent) {
        super(parent);
    }

    @Override
    public void bind(PropertyList pList) throws FOPException {
        super.bind(pList);
        startingState = pList.get(PR_STARTING_STATE).getEnum();
        caseName = pList.get(PR_CASE_NAME).getString();
        caseTitle = pList.get(PR_CASE_TITLE).getString();
        if (startingState == EN_SHOW) {
            MultiSwitch multiSwitch = (MultiSwitch) parent;
            if (multiSwitch.getCurrentlyVisibleNode() == null) {
                multiSwitch.setCurrentlyVisibleNode(this);
            }
        }
    }

    /**
     * Content Model: (#PCDATA|%inline;|%block)*
     */
    @Override
    protected void validateChildNode(Locator loc, String nsURI, String localName)
            throws ValidationException {
        if (FO_URI.equals(nsURI)) {
            if (!isBlockOrInlineItem(nsURI, localName) || "marker".equals(localName)) {
                invalidChildError(loc, nsURI, localName);
            }
            if (!"multi-toggle".equals(localName)) {
                // Validate against parent of fo:multi-switch
                FONode.validateChildNode(getParent().getParent(), loc, nsURI, localName);
            }
        }
    }

    @Override
    public void endOfNode() throws FOPException {
        if (firstChild == null) {
            missingChildElementError("(#PCDATA|%inline;|%block)*");
        }
    }

    @Override
    protected void addChildNode(FONode child) throws FOPException {
        if (child instanceof MultiCaseHandler) {
            multiCaseHandler = (MultiCaseHandler) child;
        }
        super.addChildNode(child);
    }

    /** @return the "starting-state" property */
    public int getStartingState() {
        return startingState;
    }

    @Override
    public String getLocalName() {
        return "multi-case";
    }

    /**
     * {@inheritDoc}
     * @return {@link org.apache.fop.fo.Constants#FO_MULTI_CASE}
     */
    @Override
    public int getNameId() {
        return FO_MULTI_CASE;
    }

    public String getCaseName() {
        return caseName;
    }

    public String getCaseTitle() {
        return caseTitle;
    }

    public boolean hasToggle() {
        return multiCaseHandler != null;
    }

    MultiCaseHandler getHandler() {
        return multiCaseHandler;
    }

}