Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: drawing ::
service CaptionShape
Description The CaptionShape represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing.

Included Services
Shape | Description the position and size is only used for the caption area
FillProperties | This is a set of properties to describe the style for rendering an area.
LineProperties | This is a set of properties to describe the style for rendering a Line.
ShadowProperties | This is a set of properties to describe the style for rendering a shadow.
Text | This abstract service specifies the general characteristics of an optional text inside a Shape .
RotationDescriptor | This abstract service specifies the general characteristics of an optional rotation and shearing for a Shape .

Properties' Summary
CornerRadius | This is the radius of the caption area corners.
CaptionPoint | The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area.
CaptionType | This property specifies the geometry of the line of a caption.
CaptionIsFixedAngle | This property specifies if the escape angle of the line of a caption is fixed or free. If this is set to false , the application can choose the best possible angle. If not, the value in `CaptionAngle` is used.
CaptionAngle | This property specifies the escape angle of the line of a caption. It is only used if`CaptionIsFixedAngle` is set to true
CaptionGap | This property specifies the distance between the text area of the caption and the start of the line.
CaptionEscapeDirection | This property specifies the escape direction for the line of a caption.
CaptionIsEscapeRelative | If this property is true , the property`CaptionEscapeRelative` is used, else the property`CaptionEscapeAbsolute` is used.
CaptionEscapeRelative | This property specifies the relativ escape distance for the line of a caption.
CaptionEscapeAbsolute | This property specifies the absolut escape distance for the line of a caption.
CaptionLineLength | This property specifies the length of the caption line.
CaptionIsFitLineLength | If this property is true , the application determines the best possible length for the caption line.

Properties' Details
CornerRadius
long CornerRadius; Description This is the radius of the caption area corners.
CaptionPoint
::com::sun::star::awt::Point CaptionPoint; Description The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area.
CaptionType
short CaptionType; Description This property specifies the geometry of the line of a caption. See also CaptionType
CaptionIsFixedAngle
boolean CaptionIsFixedAngle; Description This property specifies if the escape angle of the line of a caption is fixed or free. If this is set to false , the application can choose the best possible angle. If not, the value in `CaptionAngle` is used.
CaptionAngle
long CaptionAngle; Description This property specifies the escape angle of the line of a caption. It is only used if`CaptionIsFixedAngle` is set to true
CaptionGap
long CaptionGap; Description This property specifies the distance between the text area of the caption and the start of the line.
CaptionEscapeDirection
long CaptionEscapeDirection; Description This property specifies the escape direction for the line of a caption. See also CaptionEscapeDirection
CaptionIsEscapeRelative
boolean CaptionIsEscapeRelative; Description If this property is true , the property`CaptionEscapeRelative` is used, else the property`CaptionEscapeAbsolute` is used.
CaptionEscapeRelative
long CaptionEscapeRelative; Description This property specifies the relativ escape distance for the line of a caption.
CaptionEscapeAbsolute
long CaptionEscapeAbsolute; Description This property specifies the absolut escape distance for the line of a caption.
CaptionLineLength
long CaptionLineLength; Description This property specifies the length of the caption line.
CaptionIsFitLineLength
boolean CaptionIsFitLineLength; Description If this property is true , the application determines the best possible length for the caption line.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.