Liking cljdoc? Tell your friends :D

javax.swing.border.TitledBorder

A class which implements an arbitrary border with the addition of a String title in a specified position and justification.

If the border, font, or color property values are not specified in the constructor or by invoking the appropriate set methods, the property values will be defined by the current look and feel, using the following property names in the Defaults Table:

"TitledBorder.border" "TitledBorder.font" "TitledBorder.titleColor"

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

A class which implements an arbitrary border
with the addition of a String title in a
specified position and justification.

If the border, font, or color property values are not
specified in the constructor or by invoking the appropriate
set methods, the property values will be defined by the current
look and feel, using the following property names in the
Defaults Table:

"TitledBorder.border"
"TitledBorder.font"
"TitledBorder.titleColor"


Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing.  As of 1.4, support for long term storage
of all JavaBeans™
has been added to the java.beans package.
Please see XMLEncoder.
raw docstring

*-above-bottomclj

Static Constant.

Position the title above the border's bottom line.

type: int

Static Constant.

Position the title above the border's bottom line.

type: int
raw docstring

*-above-topclj

Static Constant.

Position the title above the border's top line.

type: int

Static Constant.

Position the title above the border's top line.

type: int
raw docstring

*-below-bottomclj

Static Constant.

Position the title below the border's bottom line.

type: int

Static Constant.

Position the title below the border's bottom line.

type: int
raw docstring

*-below-topclj

Static Constant.

Position the title below the border's top line.

type: int

Static Constant.

Position the title below the border's top line.

type: int
raw docstring

*-bottomclj

Static Constant.

Position the title in the middle of the border's bottom line.

type: int

Static Constant.

Position the title in the middle of the border's bottom line.

type: int
raw docstring

*-centerclj

Static Constant.

Position title text in the center of the border line.

type: int

Static Constant.

Position title text in the center of the border line.

type: int
raw docstring

*-default-justificationclj

Static Constant.

Use the default justification for the title text.

type: int

Static Constant.

Use the default justification for the title text.

type: int
raw docstring

*-default-positionclj

Static Constant.

Use the default vertical orientation for the title text.

type: int

Static Constant.

Use the default vertical orientation for the title text.

type: int
raw docstring

*-leadingclj

Static Constant.

Position title text at the left side of the border line for left to right orientation, at the right side of the border line for right to left orientation.

type: int

Static Constant.

Position title text at the left side of the border line
  for left to right orientation, at the right side of the
  border line for right to left orientation.

type: int
raw docstring

*-leftclj

Static Constant.

Position title text at the left side of the border line.

type: int

Static Constant.

Position title text at the left side of the border line.

type: int
raw docstring

*-rightclj

Static Constant.

Position title text at the right side of the border line.

type: int

Static Constant.

Position title text at the right side of the border line.

type: int
raw docstring

*-topclj

Static Constant.

Position the title in the middle of the border's top line.

type: int

Static Constant.

Position the title in the middle of the border's top line.

type: int
raw docstring

*-trailingclj

Static Constant.

Position title text at the right side of the border line for left to right orientation, at the left side of the border line for right to left orientation.

type: int

Static Constant.

Position title text at the right side of the border line
  for left to right orientation, at the left side of the
  border line for right to left orientation.

type: int
raw docstring

->titled-borderclj

(->titled-border title)
(->titled-border border title)
(->titled-border border title title-justification title-position)
(->titled-border border title title-justification title-position title-font)
(->titled-border border
                 title
                 title-justification
                 title-position
                 title-font
                 title-color)

Constructor.

Creates a TitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color.

border - the border - javax.swing.border.Border title - the title the border should display - java.lang.String title-justification - the justification for the title - int title-position - the position for the title - int title-font - the font of the title - java.awt.Font title-color - the color of the title - java.awt.Color

Constructor.

Creates a TitledBorder instance with the specified border,
 title, title-justification, title-position, title-font, and
 title-color.

border - the border - `javax.swing.border.Border`
title - the title the border should display - `java.lang.String`
title-justification - the justification for the title - `int`
title-position - the position for the title - `int`
title-font - the font of the title - `java.awt.Font`
title-color - the color of the title - `java.awt.Color`
raw docstring

border-opaque?clj

(border-opaque? this)

Returns whether or not the border is opaque.

returns: false - boolean

Returns whether or not the border is opaque.

returns: false - `boolean`
raw docstring

get-baselineclj

(get-baseline this c width height)

Returns the baseline.

c - Component baseline is being requested for - java.awt.Component width - the width to get the baseline for - int height - the height to get the baseline for - int

returns: the baseline or < 0 indicating there is no reasonable baseline - int

throws: java.lang.NullPointerException

Returns the baseline.

c - Component baseline is being requested for - `java.awt.Component`
width - the width to get the baseline for - `int`
height - the height to get the baseline for - `int`

returns: the baseline or < 0 indicating there is no reasonable
         baseline - `int`

throws: java.lang.NullPointerException
raw docstring

get-baseline-resize-behaviorclj

(get-baseline-resize-behavior this c)

Returns an enum indicating how the baseline of the border changes as the size changes.

c - Component to return baseline resize behavior for - java.awt.Component

returns: an enum indicating how the baseline changes as the border is resized - java.awt.Component$BaselineResizeBehavior

throws: java.lang.NullPointerException

Returns an enum indicating how the baseline of the border
 changes as the size changes.

c - Component to return baseline resize behavior for - `java.awt.Component`

returns: an enum indicating how the baseline changes as the border is
         resized - `java.awt.Component$BaselineResizeBehavior`

throws: java.lang.NullPointerException
raw docstring

get-borderclj

(get-border this)

Returns the border of the titled border.

returns: the border of the titled border - javax.swing.border.Border

Returns the border of the titled border.

returns: the border of the titled border - `javax.swing.border.Border`
raw docstring

get-border-insetsclj

(get-border-insets this c insets)

Reinitialize the insets parameter with this Border's current Insets.

c - the component for which this border insets value applies - java.awt.Component insets - the object to be reinitialized - java.awt.Insets

returns: the insets object - java.awt.Insets

Reinitialize the insets parameter with this Border's current Insets.

c - the component for which this border insets value applies - `java.awt.Component`
insets - the object to be reinitialized - `java.awt.Insets`

returns: the insets object - `java.awt.Insets`
raw docstring

get-minimum-sizeclj

(get-minimum-size this c)

Returns the minimum dimensions this border requires in order to fully display the border and title.

c - the component where this border will be drawn - java.awt.Component

returns: the Dimension object - java.awt.Dimension

Returns the minimum dimensions this border requires
 in order to fully display the border and title.

c - the component where this border will be drawn - `java.awt.Component`

returns: the Dimension object - `java.awt.Dimension`
raw docstring

get-titleclj

(get-title this)

Returns the title of the titled border.

returns: the title of the titled border - java.lang.String

Returns the title of the titled border.

returns: the title of the titled border - `java.lang.String`
raw docstring

get-title-colorclj

(get-title-color this)

Returns the title-color of the titled border.

returns: the title-color of the titled border - java.awt.Color

Returns the title-color of the titled border.

returns: the title-color of the titled border - `java.awt.Color`
raw docstring

get-title-fontclj

(get-title-font this)

Returns the title-font of the titled border.

returns: the title-font of the titled border - java.awt.Font

Returns the title-font of the titled border.

returns: the title-font of the titled border - `java.awt.Font`
raw docstring

get-title-justificationclj

(get-title-justification this)

Returns the title-justification of the titled border.

returns: the title-justification of the titled border - int

Returns the title-justification of the titled border.

returns: the title-justification of the titled border - `int`
raw docstring

get-title-positionclj

(get-title-position this)

Returns the title-position of the titled border.

returns: the title-position of the titled border - int

Returns the title-position of the titled border.

returns: the title-position of the titled border - `int`
raw docstring

paint-borderclj

(paint-border this c g x y width height)

Paints the border for the specified component with the specified position and size.

c - the component for which this border is being painted - java.awt.Component g - the paint graphics - java.awt.Graphics x - the x position of the painted border - int y - the y position of the painted border - int width - the width of the painted border - int height - the height of the painted border - int

Paints the border for the specified component with the
 specified position and size.

c - the component for which this border is being painted - `java.awt.Component`
g - the paint graphics - `java.awt.Graphics`
x - the x position of the painted border - `int`
y - the y position of the painted border - `int`
width - the width of the painted border - `int`
height - the height of the painted border - `int`
raw docstring

set-borderclj

(set-border this border)

Sets the border of the titled border.

border - the border - javax.swing.border.Border

Sets the border of the titled border.

border - the border - `javax.swing.border.Border`
raw docstring

set-titleclj

(set-title this title)

Sets the title of the titled border.

title - the title for the border - java.lang.String

Sets the title of the titled border.

title - the title for the border - `java.lang.String`
raw docstring

set-title-colorclj

(set-title-color this title-color)

Sets the title-color of the titled border.

title-color - the color for the border title - java.awt.Color

Sets the title-color of the titled border.

title-color - the color for the border title - `java.awt.Color`
raw docstring

set-title-fontclj

(set-title-font this title-font)

Sets the title-font of the titled border.

title-font - the font for the border title - java.awt.Font

Sets the title-font of the titled border.

title-font - the font for the border title - `java.awt.Font`
raw docstring

set-title-justificationclj

(set-title-justification this title-justification)

Sets the title-justification of the titled border.

title-justification - the justification for the border - int

Sets the title-justification of the titled border.

title-justification - the justification for the border - `int`
raw docstring

set-title-positionclj

(set-title-position this title-position)

Sets the title-position of the titled border.

title-position - the position for the border - int

Sets the title-position of the titled border.

title-position - the position for the border - `int`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close