CadEntityBase (Aspose.CAD for Java module 25.10 API Documentation)

java.lang.Object
- com.aspose.cad.fileformats.cad.cadobjects.CadObjectBase
- - com.aspose.cad.fileformats.cad.cadobjects.CadOwnedObjectBase
  - - com.aspose.cad.fileformats.cad.cadobjects.CadEntityBase

All Implemented Interfaces:

ICadObjectContainer, IDrawingEntity, IMeasurableEntity

Direct Known Subclasses:

Cad3DFace, CadAcadProxyEntity, CadAcidBlockReferenceEntity, CadBaseInfinityEntity, CadBlockNameEntity, CadCoordinationModel, CadExtrudedEntityBase, CadHelix, CadLeader, CadLight, CadMesh, CadMLeader, CadMLeaderContextData, CadMLeaderLine, CadMLeaderNode, CadMLeaderStyle, CadObjectWithAcisData, CadOle2Frame, CadOleFrame, CadSection, CadSeqend, CadSpline, CadSun, CadTableEntity, CadUnused, CadVertexBase, CadViewport, CadWipeoutBase
```
public abstract class CadEntityBase
extends CadOwnedObjectBase
implements IDrawingEntity, IMeasurableEntity
```
The Cad base entity object.

Constructor Summary

Constructors
Constructor and Description

CadEntityBase()
Initializes a new instance of the CadEntityBase class.

Constructors
Constructor and Description
`CadEntityBase()` Initializes a new instance of the `CadEntityBase` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getArea()` Gets the area of the entity.
`String`	`getAssocViewPortHandle()` Gets or sets of the associated view port handle.
`List<Cad3DPoint>`	`getBounds()` Minimal and maximal points of entity.
`List<CadEntityBase>`	`getChildObjects()` Gets or sets the child entities that make up the current entity.
`List<IDrawingEntity>`	`getChilds()` Gets the collection of a nested entities.
`String`	`getColorHandle()` Gets or sets the color handle.
`short`	`getColorId()` Gets or sets the color id (ACI color) of the entity.
`String`	`getColorName()` Gets or sets the name of the color.
`Integer`	`getColorValue()` Gets or sets the true color value (RGB) of the entity.
`byte`	`getEntmode()` Gets or sets the entity mode
`String`	`getGroupHandle()` The group handle
`String`	`getHyperlink()` Gets or sets a hyperlink to an entity and displays the hyperlink name or description (if one is specified).
`String`	`getId()` Gets the identifier.
`String`	`getLayerName()` Gets or sets the name of the layer the entity belongs to.
`String`	`getLayoutTabName()` Gets or sets the name of the layout tab.
`double`	`getLength()` Gets the length of the entity.
`double`	`getLineScale()` Gets or sets the linetype scale factor of the entity.
`String`	`getLineTypeName()` Gets or sets the name of the line type based on the `LType`(`CadEntityBase.getLType()`/`CadEntityBase.setLType(byte)`) value.
`short`	`getLineWeight()` Gets or sets the line weight for the entity.
`byte`	`getLType()` Gets or sets a value the current linetype of the entity.
`String`	`getMaterial()` Gets or sets the material.
`String`	`getPlotStyle()` Gets or sets the plot style.
`byte`	`getPlotStyleFlag()` Gets or sets a value the current plot style of the entity
`Integer`	`getProxyBytesCount()` Gets or sets the proxy bytes count.
`byte[]`	`getProxyData()` Gets or sets the proxy data.
`CadShadowMode`	`getShadowMode()` Gets or sets the shadow mode.
`CadEntitySpaceMode`	`getSpaceMode()` Gets or sets a value indicating which space the entity belongs to.
`boolean`	`getStorageFlag()` Gets or sets a value indicating that this entity has associated binary data in the data store.
`Integer`	`getTransparency()` Gets or sets the transparency value for the entity.
`CadEntityTypeName`	`getTypeName()` Gets the name of the type.
`short`	`getVisible()` Gets or sets a value indicating whether this `CadEntityBase` is visible.
`boolean`	`getXDirMissingFlag()` Gets or sets a value indicating that no XDictionary handle is stored for this entity.
`boolean`	`isAssocViewPortHandleSet()` Gets a value indicating whether associated view port handle is set.
`boolean`	`isByLayer()` Gets or sets a value indicating that the entity has linetype set by layer.
`boolean`	`isNoLinks()` Gets or sets a value indicating that the entity has no links.
`void`	`setBounds(List<Cad3DPoint> value)` Minimal and maximal points of entity.
`void`	`setByLayer(boolean value)` Gets or sets a value indicating that the entity has linetype set by layer.
`void`	`setChildObjects(List<CadEntityBase> value)` Gets or sets the child entities that make up the current entity.
`void`	`setColorHandle(String value)` Gets or sets the color handle.
`void`	`setColorId(short value)` Gets or sets the color id (ACI color) of the entity.
`void`	`setColorName(String value)` Gets or sets the name of the color.
`void`	`setColorValue(Integer value)` Gets or sets the true color value (RGB) of the entity.
`void`	`setEntmode(byte value)` Gets or sets the entity mode
`void`	`setGroupHandle(String value)` The group handle
`void`	`setHyperlink(String value)` Gets or sets a hyperlink to an entity and displays the hyperlink name or description (if one is specified).
`void`	`setId(String value)` Gets the identifier.
`void`	`setLayerName(String value)` Gets or sets the name of the layer the entity belongs to.
`void`	`setLayoutTabName(String value)` Gets or sets the name of the layout tab.
`void`	`setLineScale(double value)` Gets or sets the linetype scale factor of the entity.
`void`	`setLineTypeName(String value)` Gets or sets the name of the line type based on the `LType`(`CadEntityBase.getLType()`/`CadEntityBase.setLType(byte)`) value.
`void`	`setLineWeight(short value)` Gets or sets the line weight for the entity.
`void`	`setLType(byte value)` Gets or sets a value the current linetype of the entity.
`void`	`setMaterial(String value)` Gets or sets the material.
`void`	`setNoLinks(boolean value)` Gets or sets a value indicating that the entity has no links.
`void`	`setPlotStyle(String value)` Gets or sets the plot style.
`void`	`setPlotStyleFlag(byte value)` Gets or sets a value the current plot style of the entity
`void`	`setProxyBytesCount(Integer value)` Gets or sets the proxy bytes count.
`void`	`setProxyData(byte[] value)` Gets or sets the proxy data.
`void`	`setShadowMode(CadShadowMode value)` Gets or sets the shadow mode.
`void`	`setSpaceMode(CadEntitySpaceMode value)` Gets or sets a value indicating which space the entity belongs to.
`void`	`setStorageFlag(boolean value)` Gets or sets a value indicating that this entity has associated binary data in the data store.
`void`	`setTransparency(Integer value)` Gets or sets the transparency value for the entity.
`void`	`setVisible(short value)` Gets or sets a value indicating whether this `CadEntityBase` is visible.
`void`	`setXDirMissingFlag(boolean value)` Gets or sets a value indicating that no XDictionary handle is stored for this entity.

Methods inherited from class com.aspose.cad.fileformats.cad.cadobjects.CadOwnedObjectBase
getHardOwner, getNumreactors, getReactors, getSoftOwner, isSoftOwnerSet, setHardOwner, setNumreactors, setReactors, setSoftOwner

Methods inherited from class com.aspose.cad.fileformats.cad.cadobjects.CadObjectBase
getApplicationCodesContainer, getAttribute102Values, getAttributes, getEmbeddedObjectsContainer, getObjectHandle, getUID, getXdataContainer, setApplicationCodesContainer, setAttribute102Values, setAttributes, setEmbeddedObjectsContainer, setObjectHandle, setUID, setXdataContainer

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - CadEntityBase
```
public CadEntityBase()
```
 Initializes a new instance of the CadEntityBase class.
- Method Detail
 - getId
```
public String getId()
```
 Gets the identifier.
 Value: The identifier.
 
 Specified by:
 
 getId in interface IDrawingEntity
 - setId
```
public void setId(String value)
```
 Gets the identifier.
 Value: The identifier.
 - getChilds
```
public final List<IDrawingEntity> getChilds()
```
 Description copied from interface: IDrawingEntity
 
 Gets the collection of a nested entities.
 
 Specified by:
 
 getChilds in interface IDrawingEntity
 - getTypeName
```
public CadEntityTypeName getTypeName()
```
 Gets the name of the type.
 Value: The name of the type.
 - getChildObjects
```
public final List<CadEntityBase> getChildObjects()
```
 Gets or sets the child entities that make up the current entity.
 This collection is set if this entity is complex, such as CadEntityTypeName.INSERT, CadEntityTypeName.POLYLINE, etc.
 - setChildObjects
```
public final void setChildObjects(List<CadEntityBase> value)
```
 Gets or sets the child entities that make up the current entity.
 This collection is set if this entity is complex, such as CadEntityTypeName.INSERT, CadEntityTypeName.POLYLINE, etc.
 - getColorId
```
public final short getColorId()
```
 Gets or sets the color id (ACI color) of the entity.
 Value: An int value representing the entity ACI color value.
 - setColorId
```
public final void setColorId(short value)
```
 Gets or sets the color id (ACI color) of the entity.
 Value: An int value representing the entity ACI color value.
 - getLayoutTabName
```
public final String getLayoutTabName()
```
 Gets or sets the name of the layout tab.
 Value: The name of the layout tab.
 - setLayoutTabName
```
public final void setLayoutTabName(String value)
```
 Gets or sets the name of the layout tab.
 Value: The name of the layout tab.
 - getColorName
```
public final String getColorName()
```
 Gets or sets the name of the color.
 Value: The name of the color.
 Presented if a color from the Color Books has been selected for the entity.
 - setColorName
```
public final void setColorName(String value)
```
 Gets or sets the name of the color.
 Value: The name of the color.
 Presented if a color from the Color Books has been selected for the entity.
 - getColorValue
```
public final Integer getColorValue()
```
 Gets or sets the true color value (RGB) of the entity.
 Value: An int value representing the entity RGB color value.
 - setColorValue
```
public final void setColorValue(Integer value)
```
 Gets or sets the true color value (RGB) of the entity.
 Value: An int value representing the entity RGB color value.
 - getLayerName
```
public final String getLayerName()
```
 Gets or sets the name of the layer the entity belongs to.
 Value: The name of the layer.
 - setLayerName
```
public final void setLayerName(String value)
```
 Gets or sets the name of the layer the entity belongs to.
 Value: The name of the layer.
 - getLineScale
```
public final double getLineScale()
```
 Gets or sets the linetype scale factor of the entity.
 Value: The linetype scale factor.
 - setLineScale
```
public final void setLineScale(double value)
```
 Gets or sets the linetype scale factor of the entity.
 Value: The linetype scale factor.
 - getLineTypeName
```
public final String getLineTypeName()
```
 Gets or sets the name of the line type based on the LType(CadEntityBase.getLType()/CadEntityBase.setLType(byte)) value.
 Value: The name of the line type.
 - setLineTypeName
```
public final void setLineTypeName(String value)
```
 Gets or sets the name of the line type based on the LType(CadEntityBase.getLType()/CadEntityBase.setLType(byte)) value.
 Value: The name of the line type.
 - getLineWeight
```
public final short getLineWeight()
```
 Gets or sets the line weight for the entity.
 Value: The line weight.
 This property is always 0 for versions earlier than CadAcadVersion.AC1015.
 - setLineWeight
```
public final void setLineWeight(short value)
```
 Gets or sets the line weight for the entity.
 Value: The line weight.
 This property is always 0 for versions earlier than CadAcadVersion.AC1015.
 - getMaterial
```
public final String getMaterial()
```
 Gets or sets the material.
 Value: The material.
 - setMaterial
```
public final void setMaterial(String value)
```
 Gets or sets the material.
 Value: The material.
 - getColorHandle
```
public final String getColorHandle()
```
 Gets or sets the color handle.
 - setColorHandle
```
public final void setColorHandle(String value)
```
 Gets or sets the color handle.
 - getPlotStyle
```
public final String getPlotStyle()
```
 Gets or sets the plot style. Gets or sets the plot style handle.
 Value: The plot style handle.
 Present if the value of PlotStyleFlag(CadEntityBase.getPlotStyleFlag()/CadEntityBase.setPlotStyleFlag(byte)) is 3.
 - setPlotStyle
```
public final void setPlotStyle(String value)
```
 Gets or sets the plot style. Gets or sets the plot style handle.
 Value: The plot style handle.
 Present if the value of PlotStyleFlag(CadEntityBase.getPlotStyleFlag()/CadEntityBase.setPlotStyleFlag(byte)) is 3.
 - getProxyBytesCount
```
public final Integer getProxyBytesCount()
```
 Gets or sets the proxy bytes count.
 Value: The proxy bytes count in the ProxyData(CadEntityBase.getProxyData()/CadEntityBase.setProxyData(byte[])).
 Equals null if this entity is not a Proxy Entity.
 - setProxyBytesCount
```
public final void setProxyBytesCount(Integer value)
```
 Gets or sets the proxy bytes count.
 Value: The proxy bytes count in the ProxyData(CadEntityBase.getProxyData()/CadEntityBase.setProxyData(byte[])).
 Equals null if this entity is not a Proxy Entity.
 - getProxyData
```
public final byte[] getProxyData()
```
 Gets or sets the proxy data.
 Value: The proxy data.
 This array is empty if this entity is not a Proxy Entity
 - setProxyData
```
public final void setProxyData(byte[] value)
```
 Gets or sets the proxy data.
 Value: The proxy data.
 This array is empty if this entity is not a Proxy Entity
 - getShadowMode
```
public final CadShadowMode getShadowMode()
```
 Gets or sets the shadow mode.
 Value: The shadow mode.
 - setShadowMode
```
public final void setShadowMode(CadShadowMode value)
```
 Gets or sets the shadow mode.
 Value: The shadow mode.
 - getSpaceMode
```
public final CadEntitySpaceMode getSpaceMode()
```
 Gets or sets a value indicating which space the entity belongs to.
 
 Throws:
 
 CadException - Space mode is not valid Value: The CadEntitySpaceMode value.
 - setSpaceMode
```
public final void setSpaceMode(CadEntitySpaceMode value)
```
 Gets or sets a value indicating which space the entity belongs to.
 
 Throws:
 
 CadException - Space mode is not valid Value: The CadEntitySpaceMode value.
 - getBounds
```
public final List<Cad3DPoint> getBounds()
```
 Minimal and maximal points of entity. Filled after GetBounds is called for CadImage.
 - setBounds
```
public final void setBounds(List<Cad3DPoint> value)
```
 Minimal and maximal points of entity. Filled after GetBounds is called for CadImage.
 - getTransparency
```
public final Integer getTransparency()
```
 Gets or sets the transparency value for the entity.
 Value: The transparency value.
 - setTransparency
```
public final void setTransparency(Integer value)
```
 Gets or sets the transparency value for the entity.
 Value: The transparency value.
 - getVisible
```
public short getVisible()
```
 Gets or sets a value indicating whether this CadEntityBase is visible.
 Value: true if visible; otherwise, false.
 - setVisible
```
public void setVisible(short value)
```
 Gets or sets a value indicating whether this CadEntityBase is visible.
 Value: true if visible; otherwise, false.
 - getHyperlink
```
public final String getHyperlink()
```
 Gets or sets a hyperlink to an entity and displays the hyperlink name or description (if one is specified).
 Value: The hyperlink name or description (if one is specified).
 - setHyperlink
```
public final void setHyperlink(String value)
```
 Gets or sets a hyperlink to an entity and displays the hyperlink name or description (if one is specified).
 Value: The hyperlink name or description (if one is specified).
 - getEntmode
```
public final byte getEntmode()
```
 Gets or sets the entity mode
 Value: The entity mode.
 - setEntmode
```
public final void setEntmode(byte value)
```
 Gets or sets the entity mode
 Value: The entity mode.
 - getXDirMissingFlag
```
public final boolean getXDirMissingFlag()
```
 Gets or sets a value indicating that no XDictionary handle is stored for this entity.
 Value: if the entity doesn't have an XDictionary handle.
 This flag is always false for CadAcadVersion.AC1015 and earlier versions.
 - setXDirMissingFlag
```
public final void setXDirMissingFlag(boolean value)
```
 Gets or sets a value indicating that no XDictionary handle is stored for this entity.
 Value: if the entity doesn't have an XDictionary handle.
 This flag is always false for CadAcadVersion.AC1015 and earlier versions.
 - getStorageFlag
```
public final boolean getStorageFlag()
```
 Gets or sets a value indicating that this entity has associated binary data in the data store.
 Value: if the entity has associated binary data.
 This flag is always false for CadAcadVersion.AC1024 and earlier versions.
 
 Overrides:
 
 getStorageFlag in class CadOwnedObjectBase
 - setStorageFlag
```
public final void setStorageFlag(boolean value)
```
 Gets or sets a value indicating that this entity has associated binary data in the data store.
 Value: if the entity has associated binary data.
 This flag is always false for CadAcadVersion.AC1024 and earlier versions.
 
 Overrides:
 
 setStorageFlag in class CadOwnedObjectBase
 - isByLayer
```
public final boolean isByLayer()
```
 Gets or sets a value indicating that the entity has linetype set by layer.
 Value: if the entity has a linetype set by layer.
 This flag is always false, except for versions CadAcadVersion.AC1012 and CadAcadVersion.AC1014.
 - setByLayer
```
public final void setByLayer(boolean value)
```
 Gets or sets a value indicating that the entity has linetype set by layer.
 Value: if the entity has a linetype set by layer.
 This flag is always false, except for versions CadAcadVersion.AC1012 and CadAcadVersion.AC1014.
 - isNoLinks
```
public final boolean isNoLinks()
```
 Gets or sets a value indicating that the entity has no links.
 Value: if the entity has no links.
 For versions CadAcadVersion.AC1018 and later, this value is always true (links are not used).
 - setNoLinks
```
public final void setNoLinks(boolean value)
```
 Gets or sets a value indicating that the entity has no links.
 Value: if the entity has no links.
 For versions CadAcadVersion.AC1018 and later, this value is always true (links are not used).
 - getLType
```
public final byte getLType()
```
 Gets or sets a value the current linetype of the entity.
 Value: 0 - ByLayer,  1 - ByBlock,  2 - Continuous,  3 - Set based on AcDbObjectType.LTYPE object
 This property is always 0 for versions earlier than CadAcadVersion.AC1015.
 - setLType
```
public final void setLType(byte value)
```
 Gets or sets a value the current linetype of the entity.
 Value: 0 - ByLayer,  1 - ByBlock,  2 - Continuous,  3 - Set based on AcDbObjectType.LTYPE object
 This property is always 0 for versions earlier than CadAcadVersion.AC1015.
 - getPlotStyleFlag
```
public final byte getPlotStyleFlag()
```
 Gets or sets a value the current plot style of the entity
 Value: 0 - ByLayer,  1 - ByBlock,  3 - Set based on AcDbObjectType.PLACEHOLDER object
 This property is always 0 for versions earlier than CadAcadVersion.AC1015.
 - setPlotStyleFlag
```
public final void setPlotStyleFlag(byte value)
```
 Gets or sets a value the current plot style of the entity
 Value: 0 - ByLayer,  1 - ByBlock,  3 - Set based on AcDbObjectType.PLACEHOLDER object
 This property is always 0 for versions earlier than CadAcadVersion.AC1015.
 - getAssocViewPortHandle
```
public final String getAssocViewPortHandle()
```
 Gets or sets of the associated view port handle.
 Value: The the associated view port handle value.
 - isAssocViewPortHandleSet
```
public final boolean isAssocViewPortHandleSet()
```
 Gets a value indicating whether associated view port handle is set.
 Value: true, if the AssocViewPortHandle(CadEntityBase.getAssocViewPortHandle()/CadEntityBase.setAssocViewPortHandle_internalized(String)) has a value.
 - getArea
```
public final double getArea()
```
 Gets the area of the entity.
 
 Specified by:
 
 getArea in interface IMeasurableEntity
 - getLength
```
public final double getLength()
```
 Gets the length of the entity.
 
 Specified by:
 
 getLength in interface IMeasurableEntity
 - getGroupHandle
```
public final String getGroupHandle()
```
 The group handle
 - setGroupHandle
```
public final void setGroupHandle(String value)
```
 The group handle

Class CadEntityBase

Constructor Summary

Method Summary

Methods inherited from class com.aspose.cad.fileformats.cad.cadobjects.CadOwnedObjectBase

Methods inherited from class com.aspose.cad.fileformats.cad.cadobjects.CadObjectBase

Methods inherited from class java.lang.Object

Constructor Detail

CadEntityBase

Method Detail

getId

setId

getChilds

getTypeName

getChildObjects

setChildObjects

getColorId

setColorId

getLayoutTabName

setLayoutTabName

getColorName

setColorName

getColorValue

setColorValue

getLayerName

setLayerName

getLineScale

setLineScale

getLineTypeName

setLineTypeName

getLineWeight

setLineWeight

getMaterial

setMaterial

getColorHandle

setColorHandle

getPlotStyle

setPlotStyle

getProxyBytesCount

setProxyBytesCount

getProxyData

setProxyData

getShadowMode

setShadowMode

getSpaceMode

setSpaceMode

getBounds

setBounds

getTransparency

setTransparency

getVisible

setVisible

getHyperlink

setHyperlink

getEntmode

setEntmode

getXDirMissingFlag

setXDirMissingFlag

getStorageFlag

setStorageFlag

isByLayer

setByLayer

isNoLinks

setNoLinks

getLType

setLType

getPlotStyleFlag

setPlotStyleFlag

getAssocViewPortHandle

isAssocViewPortHandleSet

getArea

getLength

getGroupHandle

setGroupHandle