Package com.independentsoft.office.odf.drawing

Class Control

java.lang.Object

com.independentsoft.office.odf.drawing.Shape

com.independentsoft.office.odf.drawing.Control

All Implemented Interfaces:

ICellContent, IContentElement, IIndexContent, IParagraphContent, ITextContent

public class Control
extends Shape

Represents a shape that is linked to a control inside Forms element.

Field Summary

Fields inherited from class com.independentsoft.office.odf.drawing.Shape

height, id, layer, name, parent, style, textStyle, transform, width, x, y, zIndex

Constructor Summary

Constructors

Constructor	Description
Control()	Initializes a new instance of the Control class.
Control(InternalXMLStreamReader reader)	Instantiates a new control.

Method Summary

Modifier and Type	Method	Description
Control	clone()	Creates a new object that is a deep copy of the current instance.
AnchorType	getAnchorType()	Specifies how a frame is bound to a text document.
List<IContentElement>	getContentElements()	Returns all content elements.
String	getControlID()	Gets the control within a form that is linked to the control shape by its ID.
List<GluePoint>	getGluePoints()	Contains the designated point in the area of a drawing object to which a connector shape can connect.
IContentElement	getParent()	Returns the parent content element.
String	getRelativeHeight()	Gets height of a drawing object as a relative value within a frame.
String	getRelativeWidth()	Gets width of a drawing object as a relative value within a frame.
void	setAnchorType(AnchorType anchorType)	Specifies how a frame is bound to a text document.
void	setControlID(String controlID)	Sets the control within a form that is linked to the control shape by its ID.
void	setParent(IContentElement parent)	Sets the parent content element.
void	setRelativeHeight(String relativeHeight)	Sets height of a drawing object as a relative value within a frame.
void	setRelativeWidth(String relativeWidth)	Sets width of a drawing object as a relative value within a frame.
String	toString()	Converts the value of the current Control object to its equivalent string representation.

Methods inherited from class com.independentsoft.office.odf.drawing.Shape

getHeight, getID, getLayer, getName, getStyle, getTextStyle, getTransform, getWidth, getX, getY, getZIndex, setHeight, setID, setLayer, setName, setStyle, setTextStyle, setTransform, setWidth, setX, setY, setZIndex

Methods inherited from class java.lang.Object

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

Constructor Details

Control

public Control()

Initializes a new instance of the Control class.

Control

public Control(InternalXMLStreamReader reader)
        throws XMLStreamException

Instantiates a new control.

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 Shape

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 Shape

Returns:

the parent

setParent

public void setParent(IContentElement parent)

Sets the parent content element.

Specified by:

setParent in interface IContentElement

Overrides:

setParent in class Shape

Parameters:

parent - the new parent

clone

public Control clone()

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

Specified by:

clone in interface ICellContent

Specified by:

clone in interface IContentElement

Specified by:

clone in interface IIndexContent

Specified by:

clone in interface IParagraphContent

Specified by:

clone in interface ITextContent

Specified by:

clone in class Shape

Returns:

A new object that is a copy of this instance.

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

the string

getGluePoints

public List<GluePoint> getGluePoints()

Contains the designated point in the area of a drawing object to which a connector shape can connect.

Returns:

the glue points

getRelativeWidth

public String getRelativeWidth()

Gets width of a drawing object as a relative value within a frame.

Returns:

the relative width

setRelativeWidth

public void setRelativeWidth(String relativeWidth)

Sets width of a drawing object as a relative value within a frame.

Parameters:

relativeWidth - the new relative width

getRelativeHeight

public String getRelativeHeight()

Gets height of a drawing object as a relative value within a frame.

Returns:

the relative height

setRelativeHeight

public void setRelativeHeight(String relativeHeight)

Sets height of a drawing object as a relative value within a frame.

Parameters:

relativeHeight - the new relative height

getControlID

public String getControlID()

Gets the control within a form that is linked to the control shape by its ID.

Returns:

the control id

setControlID

public void setControlID(String controlID)

Sets the control within a form that is linked to the control shape by its ID.

Parameters:

controlID - the new control id

getAnchorType

public AnchorType getAnchorType()

Specifies how a frame is bound to a text document. The anchor position is the point at which a frame is bound to a text document.

Returns:

the anchor type

setAnchorType

public void setAnchorType(AnchorType anchorType)

Specifies how a frame is bound to a text document. The anchor position is the point at which a frame is bound to a text document.

Parameters:

anchorType - the new anchor type