Package org.apache.poi.xwpf.usermodel
Enum Class Borders
- All Implemented Interfaces:
Serializable
,Comparable<Borders>
,Constable
Specifies all types of borders which can be specified for WordprocessingML
objects which have a border. Borders can be separated into two types:
- Line borders: which specify a pattern to be used when drawing a line around the specified object.
- Art borders: which specify a repeated image to be used when drawing a border around the specified object. Line borders may be specified on any object which allows a border, however, art borders may only be used as a border at the page level - the borders under the pgBorders element
- Author:
- Gisella Bronzetti
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSpecifies an art border consisting of a repeated image of an appleSpecifies an art border consisting of a repeated image of a shell patternSpecifies an art border consisting of a repeated image of a baby pacifierSpecifies an art border consisting of a repeated image of a baby rattleSpecifies an art border consisting of a repeated image of a set of balloonsSpecifies an art border consisting of a repeated image of a hot air balloonSpecifies an art border consisting of a repeating image of a black and white background.Specifies an art border consisting of a repeating image of a black dot on a white background.Specifies an art border consisting of a repeating image of a black and white backgroundSpecifies an art border consisting of a repeating image of a black and white background.Specifies an art border consisting of a repeating image of a black and white background.Specifies an art border consisting of a repeating image of a white dot on a black background.Specifies an art border consisting of a repeating image of a black and white background.Specifies an art border consisting of a repeating image of a black and white background.Specifies an art border consisting of a repeating image of a black and white backgroundSpecifies an art border consisting of a repeating image of a black and white backgroundSpecifies an art border consisting of a repeated image of batsSpecifies an art border consisting of repeating images of birdsSpecifies an art border consisting of a repeated image of birds flyingSpecifies an art border consisting of a repeated image of a cabinSpecifies an art border consisting of a repeated image of a piece of cakeSpecifies an art border consisting of a repeated image of candy cornSpecifies an art border consisting of a repeated image of a knot work patternSpecifies an art border consisting of a banner.Specifies an art border consisting of a repeating image of a chain link pattern.Specifies an art border consisting of a repeated image of a champagne bottleSpecifies an art border consisting of repeating images of a compassSpecifies an art border consisting of a repeating image of a colored pattern.Specifies an art border consisting of a repeated image of a checkerboardSpecifies an art border consisting of a repeated image of a Christmas treeSpecifies an art border consisting of repeating images of lines and circlesSpecifies an art border consisting of a repeated image of a rectangular patternSpecifies an art border consisting of a repeated image of a waveSpecifies an art border consisting of a repeated image of a clockSpecifies an art border consisting of repeating images of a compassSpecifies an art border consisting of a repeated image of confettiSpecifies an art border consisting of a repeated image of confettiSpecifies an art border consisting of a repeated image of confettiSpecifies an art border consisting of a repeated image of confetti streamersSpecifies an art border consisting of a repeated image of confettiSpecifies an art border consisting of a repeated imageSpecifies an art border consisting of a dashed lineSpecifies an art border consisting of a dotted lineSpecifies an art border consisting of a repeated image of a maze-like patternSpecifies an art border consisting of a repeated image of a butterflySpecifies an art border consisting of a repeated image of a fishSpecifies an art border consisting of repeating images of insects.Specifies an art border consisting of a repeated image of a ladybugSpecifies an art border consisting of repeating images of a cross-stitch patternSpecifies an art border consisting of a repeated image of CupidSpecifies a line border consisting of a single line around the parent object. -
Method Summary
Modifier and TypeMethodDescriptionint
getValue()
static Borders
valueOf
(int type) Returns the enum constant of this class with the specified name.static Borders
Returns the enum constant of this class with the specified name.static Borders[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NIL
-
NONE
-
SINGLE
Specifies a line border consisting of a single line around the parent object. -
THICK
-
DOUBLE
-
DOTTED
-
DASHED
-
DOT_DASH
-
DOT_DOT_DASH
-
TRIPLE
-
THIN_THICK_SMALL_GAP
-
THICK_THIN_SMALL_GAP
-
THIN_THICK_THIN_SMALL_GAP
-
THIN_THICK_MEDIUM_GAP
-
THICK_THIN_MEDIUM_GAP
-
THIN_THICK_THIN_MEDIUM_GAP
-
THIN_THICK_LARGE_GAP
-
THICK_THIN_LARGE_GAP
-
THIN_THICK_THIN_LARGE_GAP
-
WAVE
-
DOUBLE_WAVE
-
DASH_SMALL_GAP
-
DASH_DOT_STROKED
-
THREE_D_EMBOSS
-
THREE_D_ENGRAVE
-
OUTSET
-
INSET
-
APPLES
Specifies an art border consisting of a repeated image of an apple -
ARCHED_SCALLOPS
Specifies an art border consisting of a repeated image of a shell pattern -
BABY_PACIFIER
Specifies an art border consisting of a repeated image of a baby pacifier -
BABY_RATTLE
Specifies an art border consisting of a repeated image of a baby rattle -
BALLOONS_3_COLORS
Specifies an art border consisting of a repeated image of a set of balloons -
BALLOONS_HOT_AIR
Specifies an art border consisting of a repeated image of a hot air balloon -
BASIC_BLACK_DASHES
Specifies an art border consisting of a repeating image of a black and white background. -
BASIC_BLACK_DOTS
Specifies an art border consisting of a repeating image of a black dot on a white background. -
BASIC_BLACK_SQUARES
Specifies an art border consisting of a repeating image of a black and white background -
BASIC_THIN_LINES
Specifies an art border consisting of a repeating image of a black and white background. -
BASIC_WHITE_DASHES
Specifies an art border consisting of a repeating image of a black and white background. -
BASIC_WHITE_DOTS
Specifies an art border consisting of a repeating image of a white dot on a black background. -
BASIC_WHITE_SQUARES
Specifies an art border consisting of a repeating image of a black and white background. -
BASIC_WIDE_INLINE
Specifies an art border consisting of a repeating image of a black and white background. -
BASIC_WIDE_MIDLINE
Specifies an art border consisting of a repeating image of a black and white background -
BASIC_WIDE_OUTLINE
Specifies an art border consisting of a repeating image of a black and white background -
BATS
Specifies an art border consisting of a repeated image of bats -
BIRDS
Specifies an art border consisting of repeating images of birds -
BIRDS_FLIGHT
Specifies an art border consisting of a repeated image of birds flying -
CABINS
Specifies an art border consisting of a repeated image of a cabin -
CAKE_SLICE
Specifies an art border consisting of a repeated image of a piece of cake -
CANDY_CORN
Specifies an art border consisting of a repeated image of candy corn -
CELTIC_KNOTWORK
Specifies an art border consisting of a repeated image of a knot work pattern -
CERTIFICATE_BANNER
Specifies an art border consisting of a banner.If the border is on the left or right, no border is displayed.
-
CHAIN_LINK
Specifies an art border consisting of a repeating image of a chain link pattern. -
CHAMPAGNE_BOTTLE
Specifies an art border consisting of a repeated image of a champagne bottle -
CHECKED_BAR_BLACK
Specifies an art border consisting of repeating images of a compass -
CHECKED_BAR_COLOR
Specifies an art border consisting of a repeating image of a colored pattern. -
CHECKERED
Specifies an art border consisting of a repeated image of a checkerboard -
CHRISTMAS_TREE
Specifies an art border consisting of a repeated image of a Christmas tree -
CIRCLES_LINES
Specifies an art border consisting of repeating images of lines and circles -
CIRCLES_RECTANGLES
Specifies an art border consisting of a repeated image of a rectangular pattern -
CLASSICAL_WAVE
Specifies an art border consisting of a repeated image of a wave -
CLOCKS
Specifies an art border consisting of a repeated image of a clock -
COMPASS
Specifies an art border consisting of repeating images of a compass -
CONFETTI
Specifies an art border consisting of a repeated image of confetti -
CONFETTI_GRAYS
Specifies an art border consisting of a repeated image of confetti -
CONFETTI_OUTLINE
Specifies an art border consisting of a repeated image of confetti -
CONFETTI_STREAMERS
Specifies an art border consisting of a repeated image of confetti streamers -
CONFETTI_WHITE
Specifies an art border consisting of a repeated image of confetti -
CORNER_TRIANGLES
Specifies an art border consisting of a repeated image -
COUPON_CUTOUT_DASHES
Specifies an art border consisting of a dashed line -
COUPON_CUTOUT_DOTS
Specifies an art border consisting of a dotted line -
CRAZY_MAZE
Specifies an art border consisting of a repeated image of a maze-like pattern -
CREATURES_BUTTERFLY
Specifies an art border consisting of a repeated image of a butterfly -
CREATURES_FISH
Specifies an art border consisting of a repeated image of a fish -
CREATURES_INSECTS
Specifies an art border consisting of repeating images of insects. -
CREATURES_LADY_BUG
Specifies an art border consisting of a repeated image of a ladybug -
CROSS_STITCH
Specifies an art border consisting of repeating images of a cross-stitch pattern -
CUP
Specifies an art border consisting of a repeated image of Cupid -
DECO_ARCH
-
DECO_ARCH_COLOR
-
DECO_BLOCKS
-
DIAMONDS_GRAY
-
DOUBLE_D
-
DOUBLE_DIAMONDS
-
EARTH_1
-
EARTH_2
-
ECLIPSING_SQUARES_1
-
ECLIPSING_SQUARES_2
-
EGGS_BLACK
-
FANS
-
FILM
-
FIRECRACKERS
-
FLOWERS_BLOCK_PRINT
-
FLOWERS_DAISIES
-
FLOWERS_MODERN_1
-
FLOWERS_MODERN_2
-
FLOWERS_PANSY
-
FLOWERS_RED_ROSE
-
FLOWERS_ROSES
-
FLOWERS_TEACUP
-
FLOWERS_TINY
-
GEMS
-
GINGERBREAD_MAN
-
GRADIENT
-
HANDMADE_1
-
HANDMADE_2
-
HEART_BALLOON
-
HEART_GRAY
-
HEARTS
-
HEEBIE_JEEBIES
-
HOLLY
-
HOUSE_FUNKY
-
HYPNOTIC
-
ICE_CREAM_CONES
-
LIGHT_BULB
-
LIGHTNING_1
-
LIGHTNING_2
-
MAP_PINS
-
MAPLE_LEAF
-
MAPLE_MUFFINS
-
MARQUEE
-
MARQUEE_TOOTHED
-
MOONS
-
MOSAIC
-
MUSIC_NOTES
-
NORTHWEST
-
OVALS
-
PACKAGES
-
PALMS_BLACK
-
PALMS_COLOR
-
PAPER_CLIPS
-
PAPYRUS
-
PARTY_FAVOR
-
PARTY_GLASS
-
PENCILS
-
PEOPLE
-
PEOPLE_WAVING
-
PEOPLE_HATS
-
POINSETTIAS
-
POSTAGE_STAMP
-
PUMPKIN_1
-
PUSH_PIN_NOTE_2
-
PUSH_PIN_NOTE_1
-
PYRAMIDS
-
PYRAMIDS_ABOVE
-
QUADRANTS
-
RINGS
-
SAFARI
-
SAWTOOTH
-
SAWTOOTH_GRAY
-
SCARED_CAT
-
SEATTLE
-
SHADOWED_SQUARES
-
SHARKS_TEETH
-
SHOREBIRD_TRACKS
-
SKYROCKET
-
SNOWFLAKE_FANCY
-
SNOWFLAKES
-
SOMBRERO
-
SOUTHWEST
-
STARS
-
STARS_TOP
-
STARS_3_D
-
STARS_BLACK
-
STARS_SHADOWED
-
SUN
-
SWIRLIGIG
-
TORN_PAPER
-
TORN_PAPER_BLACK
-
TREES
-
TRIANGLE_PARTY
-
TRIANGLES
-
TRIBAL_1
-
TRIBAL_2
-
TRIBAL_3
-
TRIBAL_4
-
TRIBAL_5
-
TRIBAL_6
-
TWISTED_LINES_1
-
TWISTED_LINES_2
-
VINE
-
WAVELINE
-
WEAVING_ANGLES
-
WEAVING_BRAID
-
WEAVING_RIBBON
-
WEAVING_STRIPS
-
WHITE_FLOWERS
-
WOODWORK
-
X_ILLUSIONS
-
ZANY_TRIANGLES
-
ZIG_ZAG
-
ZIG_ZAG_STITCH
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
type
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getValue
public int getValue()
-