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

Represents a Border3D with an inset effect being applied. More...

Inheritance diagram for iText.Layout.Borders.InsetBorder:
iText.Layout.Borders.Border3D iText.Layout.Borders.Border

Public Member Functions

  InsetBorder (float width)
  Creates an InsetBorder instance with the specified width. More...
 
  InsetBorder (DeviceRgb color, float width)
  Creates an InsetBorder instance with the specified width and the rgb color. More...
 
  InsetBorder (DeviceCmyk color, float width)
  Creates an InsetBorder instance with the specified width and the cmyk color. More...
 
  InsetBorder (DeviceGray color, float width)
  Creates an InsetBorder instance with the specified width and the gray color. More...
 
  InsetBorder (DeviceRgb color, float width, float opacity)
  Creates an InsetBorder instance with the specified width, color and opacity. More...
 
  InsetBorder (DeviceCmyk color, float width, float opacity)
  Creates an InsetBorder instance with the specified width, color and opacity. More...
 
  InsetBorder (DeviceGray color, float width, float opacity)
  Creates an InsetBorder instance with the specified width, color and opacity. More...
 
override int  GetBorderType ()
  Returns the type of the border More...
 
- Public Member Functions inherited from iText.Layout.Borders.Border3D
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  DrawCellBorder (PdfCanvas canvas, float x1, float y1, float x2, float y2, Border.Side defaultSide)
  Draws the border of a cell. 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 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...
 
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 ()
 

Package Functions

override void  SetInnerHalfColor (PdfCanvas canvas, Border.Side side)
  Sets the fill color for the inner half of 3D Border More...
 
override void  SetOuterHalfColor (PdfCanvas canvas, Border.Side side)
  Sets the fill color for the outer half of 3D Border More...
 
- Package Functions inherited from iText.Layout.Borders.Border3D
  Border3D (float width)
  Creates a Border3D instance with the specified width. More...
 
  Border3D (DeviceRgb color, float width)
  Creates a Border3D instance with the specified width and color. More...
 
  Border3D (DeviceCmyk color, float width)
  Creates a Border3D instance with the specified width and color. More...
 
  Border3D (DeviceGray color, float width)
  Creates a Border3D instance with the specified width and color. More...
 
  Border3D (DeviceRgb color, float width, float opacity)
  Creates a Border3D instance with the specified width, color and opacity. More...
 
  Border3D (DeviceCmyk color, float width, float opacity)
  Creates a Border3D instance with the specified width, color and opacity. More...
 
  Border3D (DeviceGray color, float width, float opacity)
  Creates a Border3D instance with the specified width, color and opacity. More...
 
virtual Color  GetDarkerColor ()
  Makes the Border.transparentColor color of the border darker and returns the result 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...
 

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...
 
- 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...
 
- 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

Represents a Border3D with an inset effect being applied.

Constructor & Destructor Documentation

◆ InsetBorder() [1/7]

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

Creates an InsetBorder instance with the specified width.

Creates an InsetBorder instance with the specified width. The color is set to the predefined gray.

Parameters
width width of the border

◆ InsetBorder() [2/7]

iText.Layout.Borders.InsetBorder.InsetBorder ( DeviceRgb  color,
float  width 
)
inline

Creates an InsetBorder instance with the specified width and the rgb color.

Parameters
width width of the border
color the rgb color of the border

◆ InsetBorder() [3/7]

iText.Layout.Borders.InsetBorder.InsetBorder ( DeviceCmyk  color,
float  width 
)
inline

Creates an InsetBorder instance with the specified width and the cmyk color.

Parameters
width width of the border
color the cmyk color of the border

◆ InsetBorder() [4/7]

iText.Layout.Borders.InsetBorder.InsetBorder ( DeviceGray  color,
float  width 
)
inline

Creates an InsetBorder instance with the specified width and the gray color.

Parameters
width width of the border
color the gray color of the border

◆ InsetBorder() [5/7]

iText.Layout.Borders.InsetBorder.InsetBorder ( DeviceRgb  color,
float  width,
float  opacity 
)
inline

Creates an InsetBorder instance with the specified width, color and opacity.

Parameters
color color of the border
width width of the border
opacity opacity of the border

◆ InsetBorder() [6/7]

iText.Layout.Borders.InsetBorder.InsetBorder ( DeviceCmyk  color,
float  width,
float  opacity 
)
inline

Creates an InsetBorder instance with the specified width, color and opacity.

Parameters
color color of the border
width width of the border
opacity opacity of the border

◆ InsetBorder() [7/7]

iText.Layout.Borders.InsetBorder.InsetBorder ( DeviceGray  color,
float  width,
float  opacity 
)
inline

Creates an InsetBorder instance with the specified width, color and opacity.

Parameters
color color of the border
width width of the border
opacity opacity of the border

Member Function Documentation

◆ GetBorderType()

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

Returns the type of the border

Implements iText.Layout.Borders.Border.

◆ SetInnerHalfColor()

override void iText.Layout.Borders.InsetBorder.SetInnerHalfColor ( PdfCanvas  canvas,
Border.Side  side 
)
inlinepackagevirtual

Sets the fill color for the inner half of 3D Border

Implements iText.Layout.Borders.Border3D.

◆ SetOuterHalfColor()

override void iText.Layout.Borders.InsetBorder.SetOuterHalfColor ( PdfCanvas  canvas,
Border.Side  side 
)
inlinepackagevirtual

Sets the fill color for the outer half of 3D Border

Implements iText.Layout.Borders.Border3D.