com.arcway.cockpit.genericmodule.documentcontentmodule.docgen.provider.interfaces

Interface IPictureReference

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IPictureReference
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The IPictureReference object allows to read attribute values of a picture reference as well as accessing child items and related items. Item type constant: "gm.documentcontentmodule.pictureReference"

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the picture reference.
IContainer	getParentContainer() Returns the parent container.
IPicture	getReferenceto() Returns the linked reference to or null if none is linked.
boolean	hasContainerParent() Returns whether this picture reference has a parent of type container.

Methods inherited from interface com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

getAncestorObjects, getAttribute_asParagraphList, getAttribute_asSingleLine, getAttribute_asTimestamp_MilliSecondsSince_01_01_1970, getAttribute, getChildObjects, getChildObjects, getChildObjectsOfTypeRank, getChildObjectsWithCategory, getChildObjectsWithCategory, getChildObjectsWithDefaultCategory, getChildObjectsWithDefaultCategory, getChildrenIDPrefix, getLinkedModelElements, getObjectType, getParentObject, getRelatedLOObjects, getRelatedLOObjects, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedMDObjects, getRelatedMDObjects, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithDefaultCategory, getRelatedMDObjectsWithDefaultCategory, getUniqueIdentifier, isLinkedToAnyModelElement, toRecord

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic

getImage, getPNGFile, getSVGFile, getWMFFile

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getName

java.lang.String getName()

Returns the name of the picture reference.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

name of the picture reference (!= null)

hasContainerParent

boolean hasContainerParent()

Returns whether this picture reference has a parent of type container.

Returns:

whether this picture reference has a parent of type container

getParentContainer

IContainer getParentContainer()

Returns the parent container.

Returns:

the parent container (or null if this picture reference has no parent or a parent of a different type)

getReferenceto

IPicture getReferenceto()

Returns the linked reference to or null if none is linked.

Returns:

the linked reference to or null if none is linked