Package org.dcm4che.typeddicom.dataelements

Class ImageBoxScrollDirection

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImageBoxScrollDirection

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ImageBoxScrollDirection
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Image Box Scroll Direction
Keyword: ImageBoxScrollDirection
Tag: (0072,0310)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Hanging Protocol Display Module > Display Sets Sequence > Image Boxes Sequence > Image Box Scroll Direction
  as follows:
  Attribute Name: Image Box Scroll Direction
  Type: 1C
  Attribute Description:

  Enumerated Values:

  VERTICAL

  scroll images by row

  HORIZONTAL

  scroll images by column

  Required if the value of Image Box Layout Type (0072,0304) is TILED, and the value of Image Box Tile Horizontal Dimension (0072,0306) or Image Box Tile Vertical Dimension (0072,0308) is greater than 1.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageBoxScrollDirection.Builder<SELF extends ImageBoxScrollDirection.Builder<SELF,T>,T extends ImageBoxScrollDirection.Holder>
static interface	ImageBoxScrollDirection.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Image Box Scroll Direction" (see ImageBoxScrollDirection)
static class	ImageBoxScrollDirection.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ImageBoxScrollDirection()	Creates a new Image Box Scroll Direction object which wraps a new and empty Attributes object.
ImageBoxScrollDirection(org.dcm4che3.data.Attributes attributes)	Creates a new Image Box Scroll Direction object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ImageBoxScrollDirection	copy()	Returns a new Image Box Scroll Direction which wraps a copy of the Attributes wrapped in this Image Box Scroll Direction.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ImageBoxScrollDirection

public ImageBoxScrollDirection(org.dcm4che3.data.Attributes attributes)

Creates a new Image Box Scroll Direction object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ImageBoxScrollDirection

public ImageBoxScrollDirection()

Creates a new Image Box Scroll Direction object which wraps a new and empty Attributes object.

Method Details

copy

public ImageBoxScrollDirection copy()

Returns a new Image Box Scroll Direction which wraps a copy of the Attributes wrapped in this Image Box Scroll Direction. (see Attributes(Attributes)

Returns:

a new Image Box Scroll Direction which wraps a copy of the Attributes wrapped in this Image Box Scroll Direction.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.