com.itextpdf.layout.hyphenation.Hyphen Maven / Gradle / Ivy
/*
* 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.
*/
package com.itextpdf.layout.hyphenation;
import java.io.Serializable;
/**
* This class represents a hyphen. A 'full' hyphen is made of 3 parts:
* the pre-break text, post-break text and no-break. If no line-break
* is generated at this position, the no-break text is used, otherwise,
* pre-break and post-break are used. Typically, pre-break is equal to
* the hyphen character and the others are empty. However, this general
* scheme allows support for cases in some languages where words change
* spelling if they're split across lines, like german's 'backen' which
* hyphenates 'bak-ken'. BTW, this comes from TeX.
*
* This work was authored by Carlos Villegas ([email protected]).
*/
/**
* Represents a hyphen.
*/
public class Hyphen implements Serializable {
private static final long serialVersionUID = 8989909741110279085L;
/** pre break string */
public String preBreak;
/** no break string */
public String noBreak;
/** post break string */
public String postBreak;
/**
* Construct a hyphen.
* @param pre break string
* @param no break string
* @param post break string
*/
Hyphen(String pre, String no, String post) {
preBreak = pre;
noBreak = no;
postBreak = post;
}
/**
* Construct a hyphen.
* @param pre break string
*/
Hyphen(String pre) {
preBreak = pre;
noBreak = null;
postBreak = null;
}
/** {@inheritDoc} */
public String toString() {
if (noBreak == null
&& postBreak == null
&& preBreak != null
&& preBreak.equals("-")) {
return "-";
}
StringBuffer res = new StringBuffer("{");
res.append(preBreak);
res.append("}{");
res.append(postBreak);
res.append("}{");
res.append(noBreak);
res.append('}');
return res.toString();
}
}