Package com.independentsoft.office.odf.fields

Class FileName

java.lang.Object

com.independentsoft.office.odf.fields.Field

com.independentsoft.office.odf.fields.FileName

All Implemented Interfaces:

IContentElement, IParagraphContent

public class FileName
extends Field

Represents a field that displays the name of a file that is being edited.

Field Summary

Fields inherited from class com.independentsoft.office.odf.fields.Field

parent

Constructor Summary

Constructors

Constructor	Description
FileName()	Initializes a new instance of the FileName class.
FileName(InternalXMLStreamReader reader)	Instantiates a new file name.

Method Summary

Modifier and Type	Method	Description
FileName	clone()	Creates a new object that is a deep copy of the current instance.
List<IContentElement>	getContentElements()	Returns all content elements.
FileNameDisplayType	getDisplayType()	Specifies how much of the file name to display.
IContentElement	getParent()	Returns the parent content element.
String	getValue()	Gets the name of the file that is being edited.
boolean	isFixed()	Specifies whether the value of a field element is fixed.
void	setDisplayType(FileNameDisplayType displayType)	Specifies how much of the file name to display.
void	setFixed(boolean isFixed)	Specifies whether the value of a field element is fixed.
void	setParent(IContentElement parent)	Sets the parent content element.
void	setValue(String value)	Sets the name of the file that is being edited.
String	toString()	Converts the value of the current FileName object to its equivalent string representation.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FileName

public FileName()

Initializes a new instance of the FileName class.

FileName

public FileName(InternalXMLStreamReader reader)
         throws XMLStreamException

Instantiates a new file name.

Parameters:

reader - the reader

Throws:

XMLStreamException - the xML stream exception

Method Details

getContentElements

public List<IContentElement> getContentElements()

Returns all content elements.

Specified by:

getContentElements in interface IContentElement

Specified by:

getContentElements in class Field

Returns:

A collection of content elements.

getParent

public IContentElement getParent()

Returns the parent content element.

Specified by:

getParent in interface IContentElement

Overrides:

getParent in class Field

Returns:

the parent

setParent

public void setParent(IContentElement parent)

Sets the parent content element.

Specified by:

setParent in interface IContentElement

Overrides:

setParent in class Field

Parameters:

parent - the new parent

clone

public FileName clone()

Creates a new object that is a deep copy of the current instance.

Specified by:

clone in interface IContentElement

Specified by:

clone in interface IParagraphContent

Specified by:

clone in class Field

Returns:

A new object that is a copy of this instance.

toString

public String toString()

Converts the value of the current FileName object to its equivalent string representation.

Overrides:

toString in class Object

Returns:

the string

getDisplayType

public FileNameDisplayType getDisplayType()

Specifies how much of the file name to display.

Returns:

the display type

setDisplayType

public void setDisplayType(FileNameDisplayType displayType)

Specifies how much of the file name to display.

Parameters:

displayType - the new display type

isFixed

public boolean isFixed()

Specifies whether the value of a field element is fixed. The defined values are: - false: value of field element may be replaced with a new value in future edits. - true: value of field element shall be preserved in future edits.

Returns:

true, if is fixed

setFixed

public void setFixed(boolean isFixed)

Specifies whether the value of a field element is fixed. The defined values are: - false: value of field element may be replaced with a new value in future edits. - true: value of field element shall be preserved in future edits.

Parameters:

isFixed - the new fixed

getValue

public String getValue()

Gets the name of the file that is being edited.

Returns:

the value

setValue

public void setValue(String value)

Sets the name of the file that is being edited.

Parameters:

value - the new value