123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 |
- /* ====================================================================
- 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 org.apache.poi.hwpf.usermodel;
-
- import org.apache.poi.common.Duplicatable;
- import org.apache.poi.util.BitField;
- import org.apache.poi.util.BitFieldFactory;
- import org.apache.poi.util.LittleEndian;
- import org.apache.poi.util.Removal;
-
- /**
- * This data structure is used by a paragraph to determine how it should drop
- * its first letter. I think its the visual effect that will show a giant first
- * letter to a paragraph. I've seen this used in the first paragraph of a book
- */
- public final class DropCapSpecifier implements Duplicatable {
- private static final BitField _lines = BitFieldFactory.getInstance( 0xf8 );
- private static final BitField _type = BitFieldFactory.getInstance( 0x07 );
-
- private short _fdct;
-
- public DropCapSpecifier() {
- _fdct = 0;
- }
-
- public DropCapSpecifier(DropCapSpecifier other) {
- _fdct = other._fdct;
- }
-
- public DropCapSpecifier( byte[] buf, int offset ) {
- this( LittleEndian.getShort( buf, offset ) );
- }
-
- public DropCapSpecifier( short fdct ) {
- this._fdct = fdct;
- }
-
- @Override
- @SuppressWarnings("squid:S2975")
- @Deprecated
- @Removal(version = "5.0.0")
- public DropCapSpecifier clone() {
- return copy();
- }
-
- @Override
- public DropCapSpecifier copy() {
- return new DropCapSpecifier(this);
- }
-
- @Override
- public boolean equals( Object obj )
- {
- if ( this == obj )
- return true;
- if ( obj == null )
- return false;
- if ( getClass() != obj.getClass() )
- return false;
- DropCapSpecifier other = (DropCapSpecifier) obj;
- if ( _fdct != other._fdct )
- return false;
- return true;
- }
-
- public byte getCountOfLinesToDrop()
- {
- return (byte) _lines.getValue( _fdct );
- }
-
- public byte getDropCapType()
- {
- return (byte) _type.getValue( _fdct );
- }
-
- @Override
- public int hashCode() {
- return _fdct;
- }
-
- public boolean isEmpty()
- {
- return _fdct == 0;
- }
-
- public void setCountOfLinesToDrop( byte value )
- {
- _fdct = (short) _lines.setValue( _fdct, value );
- }
-
- public void setDropCapType( byte value )
- {
- _fdct = (short) _type.setValue( _fdct, value );
- }
-
- public short toShort()
- {
- return _fdct;
- }
-
- @Override
- public String toString()
- {
- if ( isEmpty() )
- return "[DCS] EMPTY";
-
- return "[DCS] (type: " + getDropCapType() + "; count: "
- + getCountOfLinesToDrop() + ")";
- }
- }
|