org.odftoolkit.simple.common.field
Class AuthorField

java.lang.Object
  extended by org.odftoolkit.simple.Component
      extended by org.odftoolkit.simple.common.field.Field
          extended by org.odftoolkit.simple.common.field.AuthorField

public class AuthorField
extends Field

An AuthorField represents the initials of the author or the full name of the author of a document.

NOTE: Before the document is opened in any editor, the value of this field is invalid.

Since:
0.5

Nested Class Summary
 
Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field
Field.FieldType
 
Method Summary
 Field.FieldType getFieldType()
          Return the type of this field.
 OdfElement getOdfElement()
          Return an instance of OdfElement which represents this feature.
 
Methods inherited from class org.odftoolkit.simple.Component
getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getOdfElement

public OdfElement getOdfElement()
Return an instance of OdfElement which represents this feature. If this is an initial author field, an instance of TextAuthorInitialsElement is returned, otherwise an instance of TextAuthorNameElement is returned.

Specified by:
getOdfElement in class Component
Returns:
an instance of OdfElement

getFieldType

public Field.FieldType getFieldType()
Description copied from class: Field
Return the type of this field.

Specified by:
getFieldType in class Field
Returns:
the type of this field.


Copyright © 2010-2017 The Apache Software Foundation. All Rights Reserved.