com.arcway.cockpit.docgen.provider.interfaces

Interface IElementPresentationRule

public interface IElementPresentationRule

Defines the appearance of a certain element.

Method Summary

Modifier and Type	Method and Description
double	getColorWeight() Determines "how much" the color effect is applied.
java.lang.String	getComment() Gets the comment for this element
IElementPresentationRule	getCopy() Gets a copy of this rule.
IColor	getCoronaColor() Gets the corona color.
double	getCoronaWidth() Gets the corona width.
java.lang.String	getDescription() Gets the description for this element
java.lang.String	getDisplayName() Gets the display name for this element
IColor	getFillColor() Gets the fill color.
double	getFillOpacity() Determines, how much the element should become transparent or opaque Default value is: 0 (keep original value).
IColor	getLineColor() Gets the line color.
com.arcway.planagent.controllinginterface.planviewer.IProjection	getProjection() Returns the projecton of this plan element
java.lang.String	getRole() Gets the role name for this element The role e.g. is used in SVG graphics as classID.
void	resetCorona() Resets the corona color for related elements.
void	resetFillColor() Resets the fill color for related elements.
void	resetLineColor() Resets the line color for related elements.
void	setColorWeight(double colorWeight) Determines "how much" the color effect is applied.
void	setComment(java.lang.String comment) Sets the comment for this element
void	setCommentAsStringList(java.util.Collection<? extends java.lang.String> comment) Sets the comment for this element
void	setCorona(int red, int green, int blue, double width) Sets a corona for related elements.
void	setDescription(java.lang.String description) Sets the description for this element
void	setDescriptionFromStringList(java.util.Collection<? extends java.lang.String> description) Sets the description for this element
void	setDisplayName(java.lang.String displayName) Sets the display name for this element
void	setFillColor(int red, int green, int blue) Sets a fill color for related elements.
void	setFillOpacity(double fillOpacity) Determines, how much the element should become transparent or opaque Default value is: 0 (keep original value).
void	setLineColor(int red, int green, int blue) Sets the line color for related elements.
void	setProjection(com.arcway.planagent.controllinginterface.planviewer.IProjection projection) Sets a projection, for this plan element.
void	setRole(java.lang.String role) Sets the role name for this element The role e.g. is used in SVG graphics as classID.
void	setShowGuidelines(boolean showGuidelines) Determines, if guidelines shall be drawn (e.g. a dashed border around text supplements)
boolean	showGuidelines() Determines, if guidelines shall be drawn (e.g. a dashed border around text supplements)

Method Detail

getCopy

IElementPresentationRule getCopy()

Gets a copy of this rule.

Returns:

copy

setRole

void setRole(java.lang.String role)

Sets the role name for this element

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 element

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

Returns:

null for none

setDisplayName

void setDisplayName(java.lang.String displayName)

Sets the display name for this element

Parameters:

displayName - null for default

getDisplayName

java.lang.String getDisplayName()

Gets the display name for this element

Returns:

null for default

setDescription

void setDescription(java.lang.String description)

Sets the description for this element

Parameters:

description - null for default

setDescriptionFromStringList

void setDescriptionFromStringList(java.util.Collection<? extends java.lang.String> description)

Sets the description for this element

Parameters:

description - null for default

getDescription

java.lang.String getDescription()

Gets the description for this element

Returns:

null for default

setComment

void setComment(java.lang.String comment)

Sets the comment for this element

Parameters:

comment - null for default

setCommentAsStringList

void setCommentAsStringList(java.util.Collection<? extends java.lang.String> comment)

Sets the comment for this element

Parameters:

comment - null for default

getComment

java.lang.String getComment()

Gets the comment for this element

Returns:

null for default

setFillColor

void setFillColor(int red,
                  int green,
                  int blue)

Sets a fill color for related elements.

Parameters:

red - 0..255

green - 0..255

blue - 0..255

resetFillColor

void resetFillColor()

Resets the fill color for related elements.

getFillColor

IColor getFillColor()

Gets the fill color.

Returns:

null for standard color

getFillOpacity

double getFillOpacity()

Determines, how much the element should become transparent or opaque

Default value is: 0 (keep original value).

Returns:

-1 for transparent .. 0 to keep .. +1 for opaque

setFillOpacity

void setFillOpacity(double fillOpacity)

Determines, how much the element should become transparent or opaque

Default value is: 0 (keep original value).

Parameters:

fillOpacity - -1 for transparent .. 0 to keep .. +1 for opaque

setLineColor

void setLineColor(int red,
                  int green,
                  int blue)

Sets the line color for related elements.

Parameters:

red - 0..255

green - 0..255

blue - 0..255

resetLineColor

void resetLineColor()

Resets the line color for related elements.

getLineColor

IColor getLineColor()

Gets the line color.

Returns:

null for none

setColorWeight

void setColorWeight(double colorWeight)

Determines "how much" the color effect is applied.

Default is: 1.

Parameters:

colorWeight - 0 means "no effect"/"keep original color" .. 1 means "full effect"/"use highlight color"

getColorWeight

double getColorWeight()

Determines "how much" the color effect is applied.

Default is: 1.

setCorona

void setCorona(int red,
               int green,
               int blue,
               double width)

Sets a corona for related elements.

Parameters:

red - 0..255

green - 0..255

blue - 0..255

width - corona width

resetCorona

void resetCorona()

Resets the corona color for related elements.

getCoronaColor

IColor getCoronaColor()

Gets the corona color.

Returns:

null for no corona

getCoronaWidth

double getCoronaWidth()

Gets the corona width.

Returns:

0 for no corona

setShowGuidelines

void setShowGuidelines(boolean showGuidelines)

Determines, if guidelines shall be drawn (e.g. a dashed border around text supplements)

Parameters:

showGuidelines - true to show guidelines, false otherwise

showGuidelines

boolean showGuidelines()

Determines, if guidelines shall be drawn (e.g. a dashed border around text supplements)

Returns:

true to show guidelines, false otherwise

setProjection

void setProjection(com.arcway.planagent.controllinginterface.planviewer.IProjection projection)

Sets a projection, for this plan element.

Projections are small information elements like warning sings, additonal texts, progress bars and so on.

Parameters:

projection - (use IProjectionFactory to create the projection (null for none)

getProjection

com.arcway.planagent.controllinginterface.planviewer.IProjection getProjection()

Returns the projecton of this plan element

Returns:

null for none