com.arcway.cockpit.docgen.provider.interfaces

Interface IPlanPresentationRule

public interface IPlanPresentationRule

Defines the appearance of a plan.

Method Summary

Modifier and Type	Method and Description
double	getAngle() Returns the angle.
java.lang.String	getAttributeIDForReplacedPlanElementComment() Returns the property id for comment replacement.
java.lang.String	getAttributeIDForReplacedPlanElementDescription() Returns the property id for description replacement.
java.lang.String	getAttributeIDForReplacedPlanElementName() Returns the property id for name replacement.
java.util.Map<java.lang.String,IElementPresentationRule>	getElementPresentationRules() Returns the element presentation rules.
java.lang.Double	getHeightInMM() Gets the height in MM
java.lang.String	getIndividualVersionName() Gets the individual name for the plan version (by default determined by the plan's history)
java.util.Map<java.lang.String,ILink>	getLinkMap() Returns the linkmap.
double	getOffsetXinMM() Gets the offset if explicitly set. (0 if not set)
double	getOffsetYinMM() Gets the offset if explicitly set. (0 if not set)
java.lang.String	getRole() Gets the role name for this plan The role e.g. is used in SVG graphics as classID.
java.lang.String	getStyleSheetFilename() Gets the style sheet filename.
java.lang.Double	getWidthInMM() Gets the width in MM
java.lang.Double	getZoom() Gets the zoom if explicitly set.
boolean	isElementPresentationRulesReferToModelElementUIDs() True if element presentation rules refer to model element UIDs, false if they refer to plan element UIDs.
boolean	isWithComments() Determines if comment appear.
boolean	isWithMetaInformation() Determines if meta information appear.
void	resetSize() Sets the size to default.
void	resetZoom() Resets the explicitly set zoom and offset to default.
void	setAngle(double angle) Rotates the image counter clockwise by the specified angle.
void	setAttributeIDForReplacedPlanElementComment(java.lang.String globalElementPropertyID) The plan element comments of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element.
void	setAttributeIDForReplacedPlanElementDescription(java.lang.String globalElementPropertyID) The plan element descriptions of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element.
void	setAttributeIDForReplacedPlanElementName(java.lang.String globalElementPropertyID) The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element.
void	setElementPresentationRules(java.util.Map<java.lang.String,IElementPresentationRule> elementPresentationRules) Allows to change the appearance of certain elements.
void	setElementPresentationRuleUIDsAreModelElementUIDs() Defines that the object UIDs passed to setElementPresentationRules(Map) are model element UIDs.
void	setElementPresentationRuleUIDsArePlanElementUIDs() Defines that the object UIDs passed to setElementPresentationRules(Map) are plan element UIDs.
void	setIndividualVersionName(java.lang.String individualVersionName) Sets an individual name for the plan version (by default determined by the plan's history)
void	setLinkMap(java.util.Map<java.lang.String,ILink> linkMap) When supported by the target file format, hyperlinks are created on objects that are presented in the graphic.
void	setRole(java.lang.String role) Sets the role name for this plan The role e.g. is used in SVG graphics as classID.
void	setSizeInMM(double w, double h) Sets the size of the created image in mm (target size).
void	setStyleSheetFilename(java.lang.String styleSheetFilename) Sets a style sheet filename.
void	setWithComments(boolean withComments) Defines if comment plan elements appear.
void	setWithMetaInformation(boolean withMetaInformation) Defines if meta information appear.
void	setZoom(double zoom, double offsetXinMM, double offsetYInMM) Sets zoom and offset explicitly.

Method Detail

setRole

void setRole(java.lang.String role)

Sets the role name for this plan

The role e.g. is used in SVG graphics as classID.

Parameters:

role - null for none

getRole

java.lang.String getRole()

Gets the role name for this plan

The role e.g. is used in SVG graphics as classID.

Returns:

null for none

setIndividualVersionName

void setIndividualVersionName(java.lang.String individualVersionName)

Sets an individual name for the plan version (by default determined by the plan's history)

Parameters:

individualVersionName - (null for default)

getIndividualVersionName

java.lang.String getIndividualVersionName()

Gets the individual name for the plan version (by default determined by the plan's history)

Returns:

(null for default)

setZoom

void setZoom(double zoom,
             double offsetXinMM,
             double offsetYInMM)

Sets zoom and offset explicitly.

If zoom not set, the plan is scaled in 100% if it fits into the target size (see setSizeInMM(double, double). If it does not fit, the plan is shrinked until it fits into the target image size.

If zoom is set, the give zoom will be used, i.e. the plan may be clipped if it is too big to fit into the target image.

Parameters:

zoom - 1.0 for 100%

offsetXinMM - offset X (positive to moveto the left)

offsetYInMM - offset Y (positive to move upwards)

resetZoom

void resetZoom()

Resets the explicitly set zoom and offset to default.

getZoom

java.lang.Double getZoom()

Gets the zoom if explicitly set.

Returns:

1.0 for 100%

getOffsetXinMM

double getOffsetXinMM()

Gets the offset if explicitly set. (0 if not set)

Returns:

offset X (positive to moveto the left)

getOffsetYinMM

double getOffsetYinMM()

Gets the offset if explicitly set. (0 if not set)

Returns:

offset Y (positive to move upwards)

setSizeInMM

void setSizeInMM(double w,
                 double h)

Sets the size of the created image in mm (target size).

Parameters:

w - width

h - height

resetSize

void resetSize()

Sets the size to default.

getWidthInMM

java.lang.Double getWidthInMM()

Gets the width in MM

Returns:

null for default

getHeightInMM

java.lang.Double getHeightInMM()

Gets the height in MM

Returns:

null for default

setWithMetaInformation

void setWithMetaInformation(boolean withMetaInformation)

Defines if meta information appear.

Parameters:

withMetaInformation - true or false (default is false)

isWithMetaInformation

boolean isWithMetaInformation()

Determines if meta information appear.

Returns:

true or false

setWithComments

void setWithComments(boolean withComments)

Defines if comment plan elements appear.

Parameters:

withMetaInformation - true or false (default is true)

isWithComments

boolean isWithComments()

Determines if comment appear.

Returns:

true or false

setStyleSheetFilename

void setStyleSheetFilename(java.lang.String styleSheetFilename)

Sets a style sheet filename.

Note: Style sheets are not supported by all image formats. Currently only SVG format supports CSS.

Note: If the style sheet file is to be included in the files and images folder, use relative path names for addressing the style sheet file.

Parameters:

styleSheetFilename - null for none

getStyleSheetFilename

java.lang.String getStyleSheetFilename()

Gets the style sheet filename.

Returns:

null for none

setLinkMap

void setLinkMap(java.util.Map<java.lang.String,ILink> linkMap)

When supported by the target file format, hyperlinks are created on objects that are presented in the graphic.

Parameters:

linkMap - A map containing the object's UID and the link for this object. Use IProjectDataProvider.createLink(String, String, String, String) to create link objects and use ArrayHelper.createHashSet() to create a map to put the link objects in.

getLinkMap

java.util.Map<java.lang.String,ILink> getLinkMap()

Returns the linkmap.

See setLinkMap(Map).

Returns:

link map (null for none)

setElementPresentationRules

void setElementPresentationRules(java.util.Map<java.lang.String,IElementPresentationRule> elementPresentationRules)

Allows to change the appearance of certain elements.

By default, element UIDs are model element UIDs.

Parameters:

presentationMap - A map containing the object's UID and the presentation rule for this object. Use IProjectDataProvider.createElementPresentationRule() to create presentation rule object and use ArrayHelper.createHashSet() to create a map to put the presentation rule objects into.

setElementPresentationRuleUIDsAreModelElementUIDs

void setElementPresentationRuleUIDsAreModelElementUIDs()

Defines that the object UIDs passed to setElementPresentationRules(Map) are model element UIDs.

This is the default behavior.

setElementPresentationRuleUIDsArePlanElementUIDs

void setElementPresentationRuleUIDsArePlanElementUIDs()

Defines that the object UIDs passed to setElementPresentationRules(Map) are plan element UIDs.

See IPlanElementInfo.getPlanElementUID().

getElementPresentationRules

java.util.Map<java.lang.String,IElementPresentationRule> getElementPresentationRules()

Returns the element presentation rules.

See setElementPresentationRules(Map).

Returns:

element presentation rules (null for none)

isElementPresentationRulesReferToModelElementUIDs

boolean isElementPresentationRulesReferToModelElementUIDs()

True if element presentation rules refer to model element UIDs, false if they refer to plan element UIDs.

Returns:

true for model element UIDs, false for plan element UIDs

setAttributeIDForReplacedPlanElementName

void setAttributeIDForReplacedPlanElementName(java.lang.String globalElementPropertyID)

The plan element names of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single line text.

Parameters:

globalElementPropertyID - the property id

getAttributeIDForReplacedPlanElementName

java.lang.String getAttributeIDForReplacedPlanElementName()

Returns the property id for name replacement.

See setAttributeIDForReplacedPlanElementName(String).

Returns:

element presentation rules (null for none)

setAttributeIDForReplacedPlanElementDescription

void setAttributeIDForReplacedPlanElementDescription(java.lang.String globalElementPropertyID)

The plan element descriptions of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single or multi line text.

Parameters:

globalElementPropertyID - the property id

getAttributeIDForReplacedPlanElementDescription

java.lang.String getAttributeIDForReplacedPlanElementDescription()

Returns the property id for description replacement.

See setAttributeIDForReplacedPlanElementDescription(String).

Returns:

element presentation rules (null for none)

setAttributeIDForReplacedPlanElementComment

void setAttributeIDForReplacedPlanElementComment(java.lang.String globalElementPropertyID)

The plan element comments of plan elements that are occurences of global repository elements are replaced with the value of the passed attribute of the global element. This attribute must be a single or multi line text.

Parameters:

globalElementPropertyID - the property id

getAttributeIDForReplacedPlanElementComment

java.lang.String getAttributeIDForReplacedPlanElementComment()

Returns the property id for comment replacement.

See setAttributeIDForReplacedPlanElementComment(String).

Returns:

element presentation rules (null for none)

setAngle

void setAngle(double angle)

Rotates the image counter clockwise by the specified angle.

Parameters:

angle - in dregrees, default is 0 (no rotation)

getAngle

double getAngle()

Returns the angle.

See setAngle(double).

Returns:

angle