This class represents a PDF named object.
Field Summary |
---|
public static final COSName | A | A common COSName value. |
public static final COSName | AA | A common COSName value. |
public static final COSName | ACRO_FORM | A common COSName value. |
public static final COSName | ACTUAL_TEXT | "ActualText" |
public static final COSName | ALT | "Alt" |
public static final COSName | ANNOTS | A common COSName value. |
public static final COSName | ARTIFACT | "Artifact" |
public static final COSName | ART_BOX | A common COSName value. |
public static final COSName | ASCII85_DECODE | A common COSName value. |
public static final COSName | ASCII85_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | ATTACHED | "Attached" |
public static final COSName | ASCII_HEX_DECODE | A common COSName value. |
public static final COSName | ASCII_HEX_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | AP | "AP" |
public static final COSName | B | A common COSName value. |
public static final COSName | BASE_ENCODING | A common COSName value. |
public static final COSName | BASE_FONT | A common COSName value. |
public static final COSName | BBOX | A common COSName value. |
public static final COSName | BLEED_BOX | A common COSName value. |
public static final COSName | CATALOG | A common COSName value. |
public static final COSName | C | "C" |
public static final COSName | CALGRAY | A common COSName value. |
public static final COSName | CALRGB | A common COSName value. |
public static final COSName | CCITTFAX_DECODE | A common COSName value. |
public static final COSName | CCITTFAX_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | CHAR_PROCS | A common COSName value. |
public static final COSName | CHAR_SET | A common COSName value. |
public static final COSName | CID_FONT_TYPE0 | A common COSName value. |
public static final COSName | CID_FONT_TYPE2 | A common COSName value. |
public static final COSName | CIDSYSTEMINFO | A common COSName value. |
public static final COSName | COLORSPACE | A common COSName value. |
public static final COSName | CONTENTS | A common COSName value. |
public static final COSName | COUNT | A common COSName value. |
public static final COSName | CROP_BOX | A common COSName value. |
public static final COSName | D | "D" |
public static final COSName | DCT_DECODE | A common COSName value. |
public static final COSName | DCT_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | DECODE_PARMS | "DecodeParms" |
public static final COSName | DESCENDANT_FONTS | A common COSName value. |
public static final COSName | DEST | A common COSName value. |
public static final COSName | DESTS | "Dests" |
public static final COSName | DEVICECMYK | A common COSName value. |
public static final COSName | DEVICEGRAY | A common COSName value. |
public static final COSName | DEVICEN | A common COSName value. |
public static final COSName | DEVICERGB | A common COSName value. |
public static final COSName | DIFFERENCES | A common COSName value. |
public static final COSName | DL | "DL" |
public static final COSName | DP | "DP" |
public static final COSName | DV | A common COSName value. |
public static final COSName | DW | A common COSName value. |
public static final COSName | E | "E" |
public static final COSName | EMBEDDED_FILES | "EmbeddedFiles" |
public static final COSName | ENCODING | A common COSName value. |
public static final COSName | ENCODING_90MS_RKSJ_H | A common COSName value. |
public static final COSName | ENCODING_90MS_RKSJ_V | A common COSName value. |
public static final COSName | ENCODING_ETEN_B5_H | A common COSName value. |
public static final COSName | ENCODING_ETEN_B5_V | A common COSName value. |
public static final COSName | ENCRYPT | "Encrypt" |
public static final COSName | EXT_G_STATE | "ExtGState" |
public static final COSName | EXTENDS | "Extends" |
public static final COSName | F | "F" |
public static final COSName | F_DECODE_PARMS | "FDecodeParms" |
public static final COSName | F_FILTER | "FFilter" |
public static final COSName | FIELDS | A common COSName value. |
public static final COSName | FILTER | A common COSName value. |
public static final COSName | FIRST_CHAR | A common COSName value. |
public static final COSName | FLATE_DECODE | A common COSName value. |
public static final COSName | FLATE_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | FONT | A common COSName value. |
public static final COSName | FONT_BBOX | A common COSName value. |
public static final COSName | FONT_FAMILY | A common COSName value. |
public static final COSName | FONT_FILE | A common COSName value. |
public static final COSName | FONT_FILE2 | A common COSName value. |
public static final COSName | FONT_FILE3 | A common COSName value. |
public static final COSName | FONT_DESC | A common COSName value. |
public static final COSName | FONT_MATRIX | A common COSName value. |
public static final COSName | FONT_NAME | A common COSName value. |
public static final COSName | FONT_STRETCH | A common COSName value. |
public static final COSName | FORMTYPE | A common COSName value. |
public static final COSName | FRM | A common COSName value. |
public static final COSName | H | A common COSName value. |
public static final COSName | HEIGHT | A common COSName value. |
public static final COSName | ICCBASED | A common COSName value. |
public static final COSName | ID | "ID" |
public static final COSName | ID_TREE | "IDTree" |
public static final COSName | IDENTITY_H | A common COSName value. |
public static final COSName | IMAGE | A common COSName value. |
public static final COSName | INDEX | "Index" |
public static final COSName | INDEXED | A common COSName value. |
public static final COSName | INFO | A common COSName value. |
public static final COSName | JAVA_SCRIPT | "JavaScript" |
public static final COSName | JPX_DECODE | A common COSName value. |
public static final COSName | K | "K" |
public static final COSName | KIDS | "Kids" |
public static final COSName | LAB | A common COSName value. |
public static final COSName | LANG | "Lang" |
public static final COSName | LAST_CHAR | A common COSName value. |
public static final COSName | LENGTH | A common COSName value. |
public static final COSName | LENGTH1 | A common COSName value. |
public static final COSName | LIMITS | "Limits" |
public static final COSName | LZW_DECODE | A common COSName value. |
public static final COSName | LZW_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | MAC_ROMAN_ENCODING | A common COSName value. |
public static final COSName | MARK_INFO | "MarkInfo" |
public static final COSName | MATRIX | A common COSName value. |
public static final COSName | MCID | "MCID" |
public static final COSName | MEDIA_BOX | A common COSName value. |
public static final COSName | METADATA | A common COSName value. |
public static final COSName | MM_TYPE1 | A common COSName value. |
public static final COSName | N | A common COSName value. |
public static final COSName | NAME | A common COSName value. |
public static final COSName | NAMES | "Names" |
public static final COSName | NUMS | "Numbs" |
public static final COSName | O | "O" |
public static final COSName | OBJ | "Obj" |
public static final COSName | OUTLINES | "Outlines" |
public static final COSName | OPEN_ACTION | "OpenAction" |
public static final COSName | ORDERING | A common COSName value. |
public static final COSName | P | A common COSName value. |
public static final COSName | PAGE | A common COSName value. |
public static final COSName | PAGE_LABELS | "PageLabels" |
public static final COSName | PAGE_LAYOUT | "PageLayout" |
public static final COSName | PAGE_MODE | "PageMode" |
public static final COSName | PAGES | A common COSName value. |
public static final COSName | PARENT | A common COSName value. |
public static final COSName | PARENT_TREE_NEXT_KEY | "ParentTreeNextKey" |
public static final COSName | PATTERN | A common COSName value. |
public static final COSName | PDF_DOC_ENCODING | A common COSName value. |
public static final COSName | PG | "Pg" |
public static final COSName | PREV | A common COSName value. |
public static final COSName | PROC_SET | "ProcSet" |
public static final COSName | R | A common COSName value. |
public static final COSName | REGISTRY | A common COSName value. |
public static final COSName | RESOURCES | A common COSName value. |
public static final COSName | ROLE_MAP | "RoleMap" |
public static final COSName | ROOT | A common COSName value. |
public static final COSName | ROTATE | A common COSName value. |
public static final COSName | RUN_LENGTH_DECODE | A common COSName value. |
public static final COSName | RUN_LENGTH_DECODE_ABBREVIATION | A common COSName value. |
public static final COSName | S | "S" |
public static final COSName | SEPARATION | A common COSName value. |
public static final COSName | SHADING | "Shading" |
public static final COSName | SIZE | "Size" |
public static final COSName | STANDARD_ENCODING | A common COSName value. |
public static final COSName | STRUCT_TREE_ROOT | "StructTreeRoot" |
public static final COSName | SUBTYPE | A common COSName value. |
public static final COSName | T | "T" |
public static final COSName | THREADS | "Threads" |
public static final COSName | TRIM_BOX | A common COSName value. |
public static final COSName | TRUE_TYPE | A common COSName value. |
public static final COSName | TO_UNICODE | A common COSName value. |
public static final COSName | TYPE | A common COSName value. |
public static final COSName | TYPE0 | A common COSName value. |
public static final COSName | TYPE1 | A common COSName value. |
public static final COSName | TYPE3 | A common COSName value. |
public static final COSName | URI | "URI" |
public static final COSName | V | A common COSName value. |
public static final COSName | VERSION | A common COSName value. |
public static final COSName | VIEWER_PREFERENCES | "ViewerPreferences" |
public static final COSName | W | A common COSName value. |
public static final COSName | WIDTHS | A common COSName value. |
public static final COSName | WIN_ANSI_ENCODING | A common COSName value. |
public static final COSName | XOBJECT | "XObject" |
public static final byte[] | NAME_PREFIX | The prefix to a PDF name. |
public static final byte[] | NAME_ESCAPE | The escape character for a name. |
Methods from java.lang.Object: |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method from org.apache.pdfbox.cos.COSName Detail: |
public Object accept(ICOSVisitor visitor) throws COSVisitorException {
return visitor.visitFromName(this);
}
visitor pattern double dispatch method. |
public static synchronized void clearResources() {
// Clear them all
nameMap.clear();
}
Not usually needed except if resources need to be reclaimed in a ong
running process.
Patch provided by flester@GMail.com
incorporated 5/23/08, Danielwilson@users.SourceForge.net |
public int compareTo(COSName other) {
return this.name.compareTo( other.name );
}
|
public boolean equals(Object o) {
boolean retval = this == o;
if( !retval && o instanceof COSName )
{
COSName other = (COSName)o;
retval = name == other.name || name.equals( other.name );
}
return retval;
}
|
public String getName() {
return name;
}
This will get the name of this COSName object. |
public static final COSName getPDFName(String aName) {
COSName name = null;
if( aName != null )
{
// Is it a common COSName ??
name = commonNameMap.get( aName );
if( name == null )
{
// It seems to be a document specific COSName
name = nameMap.get( aName );
if( name == null )
{
//name is added to the synchronized map in the constructor
name = new COSName( aName, false );
}
}
}
return name;
}
This will get a COSName object with that name. |
public int hashCode() {
return hashCode;
}
|
public String toString() {
return "COSName{" + name + "}";
}
|
public void writePDF(OutputStream output) throws IOException {
output.write(NAME_PREFIX);
byte[] bytes = getName().getBytes();
for (int i = 0; i < bytes.length;i++)
{
int current = ((bytes[i]+256)%256);
if(current < = 32 || current >= 127 ||
current == '(' ||
current == ')' ||
current == '[' ||
current == ']' ||
current == '/' ||
current == '%' ||
current == '< ' ||
current == ' >' ||
current == NAME_ESCAPE[0] )
{
output.write(NAME_ESCAPE);
output.write(COSHEXTable.TABLE[current]);
}
else
{
output.write(current);
}
}
}
This will output this string as a PDF object. |