cdac.medinfo.sdk.dcm30_04.baselibs

Class StructuredDisplayTextBoxSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.StructuredDisplayTextBoxSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class StructuredDisplayTextBoxSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Structured Display Text Box Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
double	getDisplayEnvironmentSpatialPosition() Retrieves the Minimal value of Display Environment Spatial Position in ppm.
short[]	getGraphicLayerRecommendedDisplayCIELabValue() Retrieves Graphic Layer Recommended Display CIELab Values in Array of short format.
java.lang.String	getUnformattedTextValue() Unformatted Text Value display within the defined bounding box
java.lang.String	getValueType() Retrieves type of the value encoded in this Item
void	setBoundingBoxTextHorizontalJustification(EnumBoundingBoxTextHorizontalJustification enumBoundingBoxTextHorizontalJustification) Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
void	setDisplayEnvironmentSpatialPosition(double dblDisplayEnvironmentSpatialPosition) Sets the Display Environment Spatial Position.
void	setGraphicLayerRecommendedDisplayCIELabValue(short[] arrGraphicLayerRecommendedDisplayCIELabValue)
void	setUnformattedTextValue(java.lang.String strUnformattedTextValue) Text data that is unformatted and whose manner of display within the defined bounding box is implementation dependent
boolean	validateForModule() Validates all the attributes in StructuredDisplayTextBoxSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in StructuredDisplayTextBoxSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

MandatoryMissingException - throws MandatoryMissingException If Conditional element fails.

InvalidItemException - Signals Item Validation is failed.

setUnformattedTextValue

public void setUnformattedTextValue(java.lang.String strUnformattedTextValue)

Text data that is unformatted and whose manner of display within the defined bounding box is implementation dependent

Parameters:

strUnformattedTextValue - user-defined comments

getUnformattedTextValue

public java.lang.String getUnformattedTextValue()

Unformatted Text Value display within the defined bounding box

Returns:

String value of Unformatted Text.

setDisplayEnvironmentSpatialPosition

public void setDisplayEnvironmentSpatialPosition(double dblDisplayEnvironmentSpatialPosition)

Sets the Display Environment Spatial Position.

Parameters:

dblDisplayEnvironmentSpatialPosition - Double value of coordinates

getDisplayEnvironmentSpatialPosition

public double getDisplayEnvironmentSpatialPosition()

Retrieves the Minimal value of Display Environment Spatial Position in ppm.

Returns:

double - double value of dblDisplayEnvironmentSpatialPosition

setBoundingBoxTextHorizontalJustification

public void setBoundingBoxTextHorizontalJustification(EnumBoundingBoxTextHorizontalJustification enumBoundingBoxTextHorizontalJustification)

Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

Parameters:

enumBoundingBoxTextHorizontalJustification - Enumerated Values:LEFT,RIGHT,CENTER

getValueType

public java.lang.String getValueType()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setGraphicLayerRecommendedDisplayCIELabValue

public void setGraphicLayerRecommendedDisplayCIELabValue(short[] arrGraphicLayerRecommendedDisplayCIELabValue)

getGraphicLayerRecommendedDisplayCIELabValue

public short[] getGraphicLayerRecommendedDisplayCIELabValue()

Retrieves Graphic Layer Recommended Display CIELab Values in Array of short format.

Returns:

short Array - frames in a Multi-frame SOP Instance.