iText 7 7.1.9 API
iText.StyledXmlParser.Css.Media.MediaDeviceDescription Class Reference

Class that bundles all the values of a media device description. More...

Public Member Functions

  MediaDeviceDescription (String type)
  See MediaType class constants for possible values. More...
 
  MediaDeviceDescription (String type, float width, float height)
  Creates a new MediaDeviceDescription instance. More...
 
virtual String  GetType ()
  Gets the type. More...
 
virtual int  GetBitsPerComponent ()
  Gets the bits per component. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetBitsPerComponent (int bitsPerComponent)
  Sets the bits per component. More...
 
virtual int  GetColorIndex ()
  Gets the color index. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetColorIndex (int colorIndex)
  Sets the color index. More...
 
virtual float  GetWidth ()
  Gets the width in points. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetWidth (float width)
  Sets the width in points. More...
 
virtual float  GetHeight ()
  Gets the height in points. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetHeight (float height)
  Sets the height in points. More...
 
virtual bool  IsGrid ()
  Checks if the media device is a grid. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetGrid (bool grid)
  Sets the grid value. More...
 
virtual String  GetScan ()
  Gets the scan value. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetScan (String scan)
  Sets the scan value. More...
 
virtual String  GetOrientation ()
  Gets the orientation. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetOrientation (String orientation)
  Sets the orientation. More...
 
virtual int  GetMonochrome ()
  Gets the number of bits per pixel on a monochrome (greyscale) device. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetMonochrome (int monochrome)
  Sets the number of bits per pixel on a monochrome (greyscale) device. More...
 
virtual float  GetResolution ()
  Gets the resolution in DPI. More...
 
virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription  SetResolution (float resolution)
  Sets the resolution in DPI. More...
 

Static Public Member Functions

static iText.StyledXmlParser.Css.Media.MediaDeviceDescription  CreateDefault ()
  Creates the default MediaDeviceDescription. More...
 
static iText.StyledXmlParser.Css.Media.MediaDeviceDescription  GetDefault ()
  Gets default MediaDeviceDescription instance. More...
 

Detailed Description

Class that bundles all the values of a media device description.

Constructor & Destructor Documentation

◆ MediaDeviceDescription() [1/2]

iText.StyledXmlParser.Css.Media.MediaDeviceDescription.MediaDeviceDescription ( String  type )
inline

See MediaType class constants for possible values.

Parameters
type a type of the media to use.

◆ MediaDeviceDescription() [2/2]

iText.StyledXmlParser.Css.Media.MediaDeviceDescription.MediaDeviceDescription ( String  type,
float  width,
float  height 
)
inline

Creates a new MediaDeviceDescription instance.

Parameters
type the type
width the width
height the height

Member Function Documentation

◆ CreateDefault()

static iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.CreateDefault ( )
inlinestatic

Creates the default MediaDeviceDescription.

Returns
the media device description

◆ GetBitsPerComponent()

virtual int iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetBitsPerComponent ( )
inlinevirtual

Gets the bits per component.

Returns
the bits per component

◆ GetColorIndex()

virtual int iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetColorIndex ( )
inlinevirtual

Gets the color index.

Returns
the color index

◆ GetDefault()

static iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetDefault ( )
inlinestatic

Gets default MediaDeviceDescription instance.

Gets default MediaDeviceDescription instance. Do not modify any fields of the returned media device description because it may lead to unpredictable results. Use CreateDefault() if you want to modify device description.

Returns
the default media device description

◆ GetHeight()

virtual float iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetHeight ( )
inlinevirtual

Gets the height in points.

Returns
the height

◆ GetMonochrome()

virtual int iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetMonochrome ( )
inlinevirtual

Gets the number of bits per pixel on a monochrome (greyscale) device.

Returns
the number of bits per pixel on a monochrome (greyscale) device

◆ GetOrientation()

virtual String iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetOrientation ( )
inlinevirtual

Gets the orientation.

Returns
the orientation

◆ GetResolution()

virtual float iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetResolution ( )
inlinevirtual

Gets the resolution in DPI.

Returns
the resolution

◆ GetScan()

virtual String iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetScan ( )
inlinevirtual

Gets the scan value.

Returns
the scan value

◆ GetType()

virtual String iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetType ( )
inlinevirtual

Gets the type.

Returns
the type

◆ GetWidth()

virtual float iText.StyledXmlParser.Css.Media.MediaDeviceDescription.GetWidth ( )
inlinevirtual

Gets the width in points.

Returns
the width

◆ IsGrid()

virtual bool iText.StyledXmlParser.Css.Media.MediaDeviceDescription.IsGrid ( )
inlinevirtual

Checks if the media device is a grid.

Returns
true, if is grid

◆ SetBitsPerComponent()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetBitsPerComponent ( int  bitsPerComponent )
inlinevirtual

Sets the bits per component.

Parameters
bitsPerComponent the bits per component
Returns
the media device description

◆ SetColorIndex()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetColorIndex ( int  colorIndex )
inlinevirtual

Sets the color index.

Parameters
colorIndex the color index
Returns
the media device description

◆ SetGrid()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetGrid ( bool  grid )
inlinevirtual

Sets the grid value.

Parameters
grid the grid value
Returns
the media device description

◆ SetHeight()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetHeight ( float  height )
inlinevirtual

Sets the height in points.

Parameters
height the height
Returns
the media device description

◆ SetMonochrome()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetMonochrome ( int  monochrome )
inlinevirtual

Sets the number of bits per pixel on a monochrome (greyscale) device.

Parameters
monochrome the number of bits per pixel on a monochrome (greyscale) device
Returns
the media device description

◆ SetOrientation()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetOrientation ( String  orientation )
inlinevirtual

Sets the orientation.

Parameters
orientation the orientation
Returns
the media device description

◆ SetResolution()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetResolution ( float  resolution )
inlinevirtual

Sets the resolution in DPI.

Parameters
resolution the resolution
Returns
the media device description

◆ SetScan()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetScan ( String  scan )
inlinevirtual

Sets the scan value.

Parameters
scan the scan value
Returns
the media device description

◆ SetWidth()

virtual iText.StyledXmlParser.Css.Media.MediaDeviceDescription iText.StyledXmlParser.Css.Media.MediaDeviceDescription.SetWidth ( float  width )
inlinevirtual

Sets the width in points.

Parameters
width the width
Returns
the media device description