iText 8.0.5 API
iText.Layout.Borders.FixedDashedBorder Class Reference

Draws a border with a specific dashes around the element it's been set to. More...

Inheritance diagram for iText.Layout.Borders.FixedDashedBorder:
iText.Layout.Borders.Border

Public Member Functions

  FixedDashedBorder (float width)
  Creates a FixedDashedBorder with the specified width. More...
 
  FixedDashedBorder (Color color, float width)
  Creates a FixedDashedBorder with the specified width and the specified color. More...
 
  FixedDashedBorder (Color color, float width, float opacity)
  Creates a FixedDashedBorder with the specified width, color and opacity. More...
 
  FixedDashedBorder (Color color, float width, float unitsOn, float unitsOff, float phase)
  Creates a FixedDashedBorder with the specified width, color, unitsOn, unitsOff and phase. More...
 
  FixedDashedBorder (Color color, float width, float opacity, float unitsOn, float unitsOff, float phase)
  Creates a FixedDashedBorder with the specified width, color, opacity, unitsOn, unitsOff and phase. More...
 
override void  Draw (PdfCanvas canvas, float x1, float y1, float x2, float y2, Border.Side defaultSide, float borderWidthBefore, float borderWidthAfter)
  All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction. More...
 
override void  Draw (PdfCanvas canvas, float x1, float y1, float x2, float y2, float horizontalRadius1, float verticalRadius1, float horizontalRadius2, float verticalRadius2, Border.Side defaultSide, float borderWidthBefore, float borderWidthAfter)
  All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction. More...
 
override void  DrawCellBorder (PdfCanvas canvas, float x1, float y1, float x2, float y2, Border.Side defaultSide)
  Draws the border of a cell. More...
 
override int  GetBorderType ()
  Returns the type of the border More...
 
- Public Member Functions inherited from iText.Layout.Borders.Border
virtual void  Draw (PdfCanvas canvas, Rectangle rectangle)
  Draw borders around the target rectangle. More...
 
virtual void  Draw (PdfCanvas canvas, float x1, float y1, float x2, float y2, float borderRadius, Border.Side defaultSide, float borderWidthBefore, float borderWidthAfter)
  All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction. More...
 
virtual Color  GetColor ()
  Gets the color of the border More...
 
virtual float  GetOpacity ()
  Gets the opacity of the border More...
 
virtual float  GetWidth ()
  Gets the width of the border More...
 
virtual void  SetColor (Color color)
  Sets the color of the border More...
 
virtual void  SetWidth (float width)
  Sets the width of the border More...
 
override bool  Equals (Object anObject)
  Indicates whether the border is equal to the given border. More...
 
override int  GetHashCode ()
 

Static Public Attributes

const float  DEFAULT_UNITS_VALUE = 3
  Default dash unitsOn and unitsOff value. More...
 
- Static Public Attributes inherited from iText.Layout.Borders.Border
static readonly iText.Layout.Borders.Border  NO_BORDER = null
  The null Border, i.e. the presence of such border is equivalent to the absence of the border More...
 
const int  SOLID = 0
  The solid border. More...
 
const int  DASHED = 1
  The dashed border. More...
 
const int  DOTTED = 2
  The dotted border. More...
 
const int  DOUBLE = 3
  The double border. More...
 
const int  ROUND_DOTS = 4
  The round-dots border. More...
 
const int  _3D_GROOVE = 5
  The 3D groove border. More...
 
const int  _3D_INSET = 6
  The 3D inset border. More...
 
const int  _3D_OUTSET = 7
  The 3D outset border. More...
 
const int  _3D_RIDGE = 8
  The 3D ridge border. More...
 
const int  DASHED_FIXED = 9
  The fixed dashed border. More...
 

Additional Inherited Members

- Public Types inherited from iText.Layout.Borders.Border
enum   Side {
  NONE, TOP, RIGHT, BOTTOM,
  LEFT
}
  Enumerates the different sides of the rectangle. More...
 
- Package Functions inherited from iText.Layout.Borders.Border
  Border (float width)
  Creates a border with the given width. More...
 
  Border (Color color, float width)
  Creates a border with given width and color. More...
 
  Border (Color color, float width, float opacity)
  Creates a border with given width, color and opacity. More...
 
virtual Border.Side  GetBorderSide (float x1, float y1, float x2, float y2, Border.Side defaultSide)
  Returns the side corresponded to the line between two points. More...
 
virtual Point  GetIntersectionPoint (Point lineBeg, Point lineEnd, Point clipLineBeg, Point clipLineEnd)
  Gets a iText.Kernel.Geom.Point in which two lines intersect. More...
 
virtual float  GetDotsGap (double distance, float initialGap)
  Adjusts the size of the gap between dots More...
 
virtual void  DrawDiscontinuousBorders (PdfCanvas canvas, Rectangle boundingRectangle, float[] horizontalRadii, float[] verticalRadii, Border.Side defaultSide, float borderWidthBefore, float borderWidthAfter)
  Perform drawing operations to draw discontinuous borders. More...
 
virtual float[]  GetStartingPointsForBorderSide (float x1, float y1, float x2, float y2, Border.Side defaultSide)
  Calculate adjusted starting points for discontinuous borders, given two opposing points (A and B) that define the bounding rectangle More...
 
- Package Attributes inherited from iText.Layout.Borders.Border
TransparentColor  transparentColor
  The color of the border. More...
 
float  width
  The width of the border. More...
 
int  type
  The type of the border. More...
 

Detailed Description

Draws a border with a specific dashes around the element it's been set to.

Constructor & Destructor Documentation

◆ FixedDashedBorder() [1/5]

iText.Layout.Borders.FixedDashedBorder.FixedDashedBorder ( float  width )
inline

Creates a FixedDashedBorder with the specified width.

Parameters
width width of the border

◆ FixedDashedBorder() [2/5]

iText.Layout.Borders.FixedDashedBorder.FixedDashedBorder ( Color  color,
float  width 
)
inline

Creates a FixedDashedBorder with the specified width and the specified color.

Parameters
color color of the border
width width of the border

◆ FixedDashedBorder() [3/5]

iText.Layout.Borders.FixedDashedBorder.FixedDashedBorder ( Color  color,
float  width,
float  opacity 
)
inline

Creates a FixedDashedBorder with the specified width, color and opacity.

Parameters
color color of the border
width width of the border
opacity the opacity which border should have

◆ FixedDashedBorder() [4/5]

iText.Layout.Borders.FixedDashedBorder.FixedDashedBorder ( Color  color,
float  width,
float  unitsOn,
float  unitsOff,
float  phase 
)
inline

Creates a FixedDashedBorder with the specified width, color, unitsOn, unitsOff and phase.

Parameters
color color of the border
width width of the border
unitsOn the number of units that must be 'on'
unitsOff the number of units that must be 'off'
phase the value of the phase

◆ FixedDashedBorder() [5/5]

iText.Layout.Borders.FixedDashedBorder.FixedDashedBorder ( Color  color,
float  width,
float  opacity,
float  unitsOn,
float  unitsOff,
float  phase 
)
inline

Creates a FixedDashedBorder with the specified width, color, opacity, unitsOn, unitsOff and phase.

Parameters
color color of the border
width width of the border
opacity the opacity which border should have
unitsOn the number of units that must be 'on'
unitsOff the number of units that must be 'off'
phase the value of the phase

Member Function Documentation

◆ Draw() [1/2]

override void iText.Layout.Borders.FixedDashedBorder.Draw ( PdfCanvas  canvas,
float  x1,
float  y1,
float  x2,
float  y2,
Border.Side  defaultSide,
float  borderWidthBefore,
float  borderWidthAfter 
)
inlinevirtual

All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction.

Implements iText.Layout.Borders.Border.

◆ Draw() [2/2]

override void iText.Layout.Borders.FixedDashedBorder.Draw ( PdfCanvas  canvas,
float  x1,
float  y1,
float  x2,
float  y2,
float  horizontalRadius1,
float  verticalRadius1,
float  horizontalRadius2,
float  verticalRadius2,
Border.Side  defaultSide,
float  borderWidthBefore,
float  borderWidthAfter 
)
inlinevirtual

All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction.

Reimplemented from iText.Layout.Borders.Border.

◆ DrawCellBorder()

override void iText.Layout.Borders.FixedDashedBorder.DrawCellBorder ( PdfCanvas  canvas,
float  x1,
float  y1,
float  x2,
float  y2,
Border.Side  defaultSide 
)
inlinevirtual

Draws the border of a cell.

Implements iText.Layout.Borders.Border.

◆ GetBorderType()

override int iText.Layout.Borders.FixedDashedBorder.GetBorderType ( )
inlinevirtual

Returns the type of the border

Implements iText.Layout.Borders.Border.

Member Data Documentation

◆ DEFAULT_UNITS_VALUE

const float iText.Layout.Borders.FixedDashedBorder.DEFAULT_UNITS_VALUE = 3
static

Default dash unitsOn and unitsOff value.