aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/traits/WritingModeTraits.java
blob: 279326afa98c828033430f3d3ff8c4cb9806b027 (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * 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.traits;

/**
 * This class provides a reusable implementation of the WritingModeTraitsSetter
 * interface.
 */
public class WritingModeTraits implements WritingModeTraitsSetter {

    private Direction inlineProgressionDirection;
    private Direction blockProgressionDirection;
    private Direction columnProgressionDirection;
    private Direction rowProgressionDirection;
    private Direction shiftDirection;
    private WritingMode writingMode;

    /**
     * Default writing mode traits constructor.
     */
    public WritingModeTraits() {
        this (WritingMode.LR_TB);
    }

    /**
     * Construct writing mode traits using the specified writing mode.
     * @param writingMode a writing mode traits object
     */
    public WritingModeTraits(WritingMode writingMode) {
        assignWritingModeTraits(writingMode);
    }

    /**
     * @return the "inline-progression-direction" trait.
     */
    public Direction getInlineProgressionDirection() {
        return inlineProgressionDirection;
    }

    /**
     * @param direction the "inline-progression-direction" trait.
     */
    public void setInlineProgressionDirection(Direction direction) {
        this.inlineProgressionDirection = direction;
    }

    /**
     * @return the "block-progression-direction" trait.
     */
    public Direction getBlockProgressionDirection() {
        return blockProgressionDirection;
    }

    /**
     * @param direction the "block-progression-direction" trait.
     */
    public void setBlockProgressionDirection(Direction direction) {
        this.blockProgressionDirection = direction;
    }

    /**
     * @return the "column-progression-direction" trait.
     */
    public Direction getColumnProgressionDirection() {
        return columnProgressionDirection;
    }

    /**
     * @param direction the "column-progression-direction" trait.
     */
    public void setColumnProgressionDirection(Direction direction) {
        this.columnProgressionDirection = direction;
    }

    /**
     * @return the "row-progression-direction" trait.
     */
    public Direction getRowProgressionDirection() {
        return rowProgressionDirection;
    }

    /**
     * @param direction the "row-progression-direction" trait.
     */
    public void setRowProgressionDirection(Direction direction) {
        this.rowProgressionDirection = direction;
    }

    /**
     * @return the "shift-direction" trait.
     */
    public Direction getShiftDirection() {
        return shiftDirection;
    }

    /**
     * @param direction the "shift-direction" trait.
     */
    public void setShiftDirection(Direction direction) {
        this.shiftDirection = direction;
    }

    /**
     * @return the "writing-mode" trait.
     */
    public WritingMode getWritingMode() {
        return writingMode;
    }

    /**
     * @param writingMode the "writing-mode" trait.
     */
    public void setWritingMode(WritingMode writingMode) {
        this.writingMode = writingMode;
    }

    /**
     * @param writingMode the "writing-mode" trait.
     */
    public void assignWritingModeTraits(WritingMode writingMode) {
        writingMode.assignWritingModeTraits(this);
    }

    /**
     * Helper function to find the writing mode traits getter (if any) that applies for
     * a given FO node.
     * @param fn the node to start searching from
     * @return the applicable writing mode traits getter, or null if none applies
     */
    public static WritingModeTraitsGetter
        getWritingModeTraitsGetter(org.apache.fop.fo.FONode fn) {
        for (org.apache.fop.fo.FONode n = fn; n != null; n = n.getParent()) {
            if (n instanceof WritingModeTraitsGetter) {
                return (WritingModeTraitsGetter) n;
            }
        }
        return null;
    }

}