Package com.luciad.format.dgn

Class TLcdDGNDisplayInfo

java.lang.Object

com.luciad.format.dgn.TLcdDGNDisplayInfo

All Implemented Interfaces:

Serializable, Cloneable

public class TLcdDGNDisplayInfo
extends Object
implements Cloneable, Serializable

This class represents the display information of the elements present in DGN files.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLASS_CONSTRUCTION	Identifier for CONSTRUCTION element class.
static final int	CLASS_CONSTRUCTION_RULE	Identifier for CONSTRUCTION_RULE element class.
static final int	CLASS_DIMENSION	Identifier for DIMENSION element class.
static final int	CLASS_LINEAR_PATTERN	Identifier for LINEAR_PATTERN element class.
static final int	CLASS_PATTERN	Identifier for PATTERN element class.
static final int	CLASS_PRIMARY	Identifier for PRIMARY element class.
static final int	CLASS_PRIMARY_RULE	Identifier for PRIMARY_RULE element class.
static final int	STYLE_DASH_DOUBLE_DOT	Identifier for DASH_DOUBLE_DOT style.
static final int	STYLE_DOT	Identifier for DOT style.
static final int	STYLE_DOT_DASH	Identifier for DOT_DASH style.
static final int	STYLE_LONG_DASH	Identifier for LONG_DASH style.
static final int	STYLE_LONG_SHORT_DASH	Identifier for LONG_SHORT_DASH style.
static final int	STYLE_MEDIUM_DASH	Identifier for MEDIUM_DASH style.
static final int	STYLE_SHORT_DASH	Identifier for SHORT_DASH style.
static final int	STYLE_SOLID	Identifier for SOLID style.

Constructor Summary

Constructors

Constructor	Description
TLcdDGNDisplayInfo(int aLevelID, int aGroupNumber, int aElementClass, boolean aLocked, boolean aNew, boolean aModified, boolean aAttributes, boolean aViewIndependent, boolean aPlanar, boolean aNonSnappable, boolean aHole, int aColor, int aWeight, int aStyle)	Creates a new TLcdDGNDisplayInfo with the given properties.
TLcdDGNDisplayInfo(int aLevelID, int aGroupNumber, int aElementClass, boolean aLocked, boolean aNew, boolean aModified, boolean aAttributes, boolean aViewIndependent, boolean aPlanar, boolean aNonSnappable, boolean aHole, int aColor, int aFillColor, int aWeight, int aStyle, ILcdDGNAttributes aDGNAttributes)	Creates a new TLcdDGNDisplayInfo with the given properties.
TLcdDGNDisplayInfo(int aLevelID, int aGroupNumber, int aElementProperties, int aElementSymbology)	Creates a new TLcdDGNDisplayInfo with the given properties.
TLcdDGNDisplayInfo(int aLevelID, int aGroupNumber, int aElementProperties, int aElementSymbology, int aFillColor, ILcdDGNAttributes aDGNAttributes)	Creates a new TLcdDGNDisplayInfo with the given properties.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object aObject)
int	getColor()	Deprecated. Use getColor(TLcdDGNColorTable) instead
Color	getColor(TLcdDGNColorTable aColorTable)	Returns the line color that should be used to draw this element.
ILcdDGNAttributes	getDGNAttributes()
int	getElementClass()
int	getElementId()	Returns the element id of this element in the DGN file.
int	getElementProperties()	Returns the properties of the element.
int	getElementSymbology()	Returns the symbology code of the element.
int	getFillColor()	Deprecated. Use getFillColor(TLcdDGNColorTable) instead.
Color	getFillColor(TLcdDGNColorTable aColorTable)	Returns the fill color that should be used to draw this element.
String	getFont()	Returns the font used by elements using this display info
int	getGroupNumber()	Returns the group number of the element.
int	getLevel()	Returns the level number of the element.
int	getLevelID()	Returns the level ID of the element.
int	getLevelIndex()	Deprecated. Use getLevelID() or getLevel().
long	getPriority()	Returns the priority, or relative ordering, of elements associated with this display info.
int	getStyle()
int	getWeight()
boolean	hasAttributes()
int	hashCode()
boolean	isColorByLevel()	Returns true if the color of this element should be taken from the corresponding level.
boolean	isDisjointLineString()
boolean	isFilled()
boolean	isHole()
boolean	isInfiniteLine()
boolean	isLocked()
boolean	isModified()
boolean	isNew()
boolean	isNonSnappable()
boolean	isOrphanCellHeader()
boolean	isOutlined()
boolean	isPlanar()
boolean	isStyleByLevel()	Returns true if the line style of this element should be taken from the corresponding level.
boolean	isViewIndependent()
boolean	isWeightByLevel()	Returns true if the line weight of this element should be taken from the corresponding level.
void	setDGNAttributes(ILcdDGNAttributes aDGNAttributes)
void	setFillColor(int aFillColor)
void	setFont(String aFont)	Sets the font to be used for elements with this display info
void	setPriority(long aPriority)	Sets the priority of elements using this display info.
void	setTrueColors(Color aLineColor, Color aFillColor)	Indicates that the given true colors should be used instead of the color table indices.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

STYLE_SOLID

public static final int STYLE_SOLID

Identifier for SOLID style.

See Also:

• Constant Field Values

STYLE_DOT

public static final int STYLE_DOT

Identifier for DOT style.

See Also:

• Constant Field Values

STYLE_MEDIUM_DASH

public static final int STYLE_MEDIUM_DASH

Identifier for MEDIUM_DASH style.

See Also:

• Constant Field Values

STYLE_LONG_DASH

public static final int STYLE_LONG_DASH

Identifier for LONG_DASH style.

See Also:

• Constant Field Values

STYLE_DOT_DASH

public static final int STYLE_DOT_DASH

Identifier for DOT_DASH style.

See Also:

• Constant Field Values

STYLE_SHORT_DASH

public static final int STYLE_SHORT_DASH

Identifier for SHORT_DASH style.

See Also:

• Constant Field Values

STYLE_DASH_DOUBLE_DOT

public static final int STYLE_DASH_DOUBLE_DOT

Identifier for DASH_DOUBLE_DOT style.

See Also:

• Constant Field Values

STYLE_LONG_SHORT_DASH

public static final int STYLE_LONG_SHORT_DASH

Identifier for LONG_SHORT_DASH style.

See Also:

• Constant Field Values

CLASS_PRIMARY

public static final int CLASS_PRIMARY

Identifier for PRIMARY element class.

See Also:

• Constant Field Values

CLASS_PATTERN

public static final int CLASS_PATTERN

Identifier for PATTERN element class.

See Also:

• Constant Field Values

CLASS_CONSTRUCTION

public static final int CLASS_CONSTRUCTION

Identifier for CONSTRUCTION element class.

See Also:

• Constant Field Values

CLASS_DIMENSION

public static final int CLASS_DIMENSION

Identifier for DIMENSION element class.

See Also:

• Constant Field Values

CLASS_PRIMARY_RULE

public static final int CLASS_PRIMARY_RULE

Identifier for PRIMARY_RULE element class.

See Also:

• Constant Field Values

CLASS_LINEAR_PATTERN

public static final int CLASS_LINEAR_PATTERN

Identifier for LINEAR_PATTERN element class.

See Also:

• Constant Field Values

CLASS_CONSTRUCTION_RULE

public static final int CLASS_CONSTRUCTION_RULE

Identifier for CONSTRUCTION_RULE element class.

See Also:

• Constant Field Values

Constructor Details

TLcdDGNDisplayInfo

public TLcdDGNDisplayInfo(int aLevelID,
 int aGroupNumber,
 int aElementClass,
 boolean aLocked,
 boolean aNew,
 boolean aModified,
 boolean aAttributes,
 boolean aViewIndependent,
 boolean aPlanar,
 boolean aNonSnappable,
 boolean aHole,
 int aColor,
 int aFillColor,
 int aWeight,
 int aStyle,
 ILcdDGNAttributes aDGNAttributes)

Creates a new TLcdDGNDisplayInfo with the given properties.

TLcdDGNDisplayInfo

public TLcdDGNDisplayInfo(int aLevelID,
 int aGroupNumber,
 int aElementClass,
 boolean aLocked,
 boolean aNew,
 boolean aModified,
 boolean aAttributes,
 boolean aViewIndependent,
 boolean aPlanar,
 boolean aNonSnappable,
 boolean aHole,
 int aColor,
 int aWeight,
 int aStyle)

Creates a new TLcdDGNDisplayInfo with the given properties.

TLcdDGNDisplayInfo

public TLcdDGNDisplayInfo(int aLevelID,
 int aGroupNumber,
 int aElementProperties,
 int aElementSymbology)

Creates a new TLcdDGNDisplayInfo with the given properties.

TLcdDGNDisplayInfo

public TLcdDGNDisplayInfo(int aLevelID,
 int aGroupNumber,
 int aElementProperties,
 int aElementSymbology,
 int aFillColor,
 ILcdDGNAttributes aDGNAttributes)

Creates a new TLcdDGNDisplayInfo with the given properties.

Method Details

getPriority

public long getPriority()

Returns the priority, or relative ordering, of elements associated with this display info.

Lower numbers mean higher priority. Elements with high priority should be drawn above elements with lower priority.

Returns:

the priority

setPriority

public void setPriority(long aPriority)

Sets the priority of elements using this display info.

Parameters:

aPriority - the priority

getLevel

public int getLevel()

Returns the level number of the element.

See Also:

• getLevelID()

getLevelIndex

public int getLevelIndex()

Deprecated.

Use getLevelID() or getLevel().

Returns the level number of the element.

getLevelID

public int getLevelID()

Returns the level ID of the element. For DGN V7 files, the level ID is always equal to the level number.

getGroupNumber

public int getGroupNumber()

Returns the group number of the element.

getElementProperties

public int getElementProperties()

Returns the properties of the element.

getElementSymbology

public int getElementSymbology()

Returns the symbology code of the element.

getElementClass

public int getElementClass()

isLocked

public boolean isLocked()

isNew

public boolean isNew()

isModified

public boolean isModified()

hasAttributes

public boolean hasAttributes()

isViewIndependent

public boolean isViewIndependent()

isPlanar

public boolean isPlanar()

isNonSnappable

public boolean isNonSnappable()

isHole

public boolean isHole()

isOrphanCellHeader

public boolean isOrphanCellHeader()

isInfiniteLine

public boolean isInfiniteLine()

isDisjointLineString

public boolean isDisjointLineString()

getElementId

public int getElementId()

Returns the element id of this element in the DGN file.

Returns:

The element id

getColor

public int getColor()

Deprecated.

Use getColor(TLcdDGNColorTable) instead

Returns the color index that should be used to draw this element.

Returns:

The color index that should be used

getColor

public Color getColor(TLcdDGNColorTable aColorTable)

Returns the line color that should be used to draw this element. This call takes into account RGB colors, if specified.

Parameters:

aColorTable - The current color table

Returns:

The (line) color that should be used.

getWeight

public int getWeight()

getStyle

public int getStyle()

isColorByLevel

public boolean isColorByLevel()

Returns true if the color of this element should be taken from the corresponding level.

Returns:

true if the color of this element is given by the level symbology, false otherwise.

isWeightByLevel

public boolean isWeightByLevel()

Returns true if the line weight of this element should be taken from the corresponding level.

Returns:

true if the line weight of the element is given by the level symbology, false otherwise

isStyleByLevel

public boolean isStyleByLevel()

Returns true if the line style of this element should be taken from the corresponding level.

Returns:

true if the line style of this element is given by the level symbology, false otherwise

isOutlined

public boolean isOutlined()

isFilled

public boolean isFilled()

getFillColor

public int getFillColor()

Deprecated.

Use getFillColor(TLcdDGNColorTable) instead.

Returns the fill color index that should be used to draw this element.

Returns:

The color index that should be used.

getFillColor

public Color getFillColor(TLcdDGNColorTable aColorTable)

Returns the fill color that should be used to draw this element. This call takes into account RGB colors, if specified.

Parameters:

aColorTable - The current color table

Returns:

The (fill) color that should be used.

setFillColor

public void setFillColor(int aFillColor)

getFont

public String getFont()

Returns the font used by elements using this display info

Returns:

the font, or null if undefined

setFont

public void setFont(String aFont)

Sets the font to be used for elements with this display info

Parameters:

aFont - the font

setTrueColors

public void setTrueColors(Color aLineColor,
 Color aFillColor)

Indicates that the given true colors should be used instead of the color table indices.

Parameters:

aLineColor - the line color

aFillColor - the line color

getDGNAttributes

public ILcdDGNAttributes getDGNAttributes()

setDGNAttributes

public void setDGNAttributes(ILcdDGNAttributes aDGNAttributes)

equals

public boolean equals(Object aObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object