grammarscope.editor.component.BalloonTip Class Reference

Inheritance diagram for grammarscope.editor.component.BalloonTip:

Collaboration diagram for grammarscope.editor.component.BalloonTip:

Classes
enum	Alignment

Public Member Functions
	BalloonTip (final JTextPane textComponent, final Component attachedComponent, final Alignment alignment, final int horizontalOffset, final int verticalOffset, final String label, final boolean useCloseButton)
void	setText (final String text)
synchronized void	setVisible (final boolean show)

Private Member Functions
Point	calcWhere ()
Dimension	calcPreferredSize ()

Private Attributes
Popup	popup
final Component	attachedComponent
final JTextComponent	textComponent
final JComponent	component
final Alignment	alignment
final int	horizontalOffset
final int	verticalOffset
final String	label

Static Private Attributes
static final long	serialVersionUID = 1L
static final Color	backcolor = new Color(255, 255, 200)
static final Border	editingBorder
static final Icon	defaultCloseIcon = new ImageIcon(BalloonTip.class.getResource("images/close_default.png"))
static final Icon	rolloverCloseIcon = new ImageIcon(BalloonTip.class.getResource("images/close_rollover.png"))
static final Icon	pressedCloseIcon = new ImageIcon(BalloonTip.class.getResource("images/close_pressed.png"))
static final int	H_SHRINK = 25
static final int	V_EXPAND = 10

Detailed Description

A balloon tip which can be displayed

• left-aligned above
• left-aligned below
• right-aligned above
• right-aligned below

the attached component. See enumeration BalloonTip.Alignment. The balloon tip uses a JTextPane to render its contents which allows use of HTML code. Create a balloon tip by using the static create methods. You can choose between two looks.

Author

Bernhard Pauler

Bernard Bou

Constructor & Destructor Documentation

BalloonTip()

grammarscope.editor.component.BalloonTip.BalloonTip	(	final JTextPane	textComponent,
		final Component	attachedComponent,
		final Alignment	alignment,
		final int	horizontalOffset,
		final int	verticalOffset,
		final String	label,
		final boolean	useCloseButton
	)

Constructor

Parameters

textComponent	internal text component
attachedComponent	external attached component
alignment	alignment
horizontalOffset	horizontal offset
verticalOffset	vertical offset
label	label
useCloseButton	whether to use close button

Member Function Documentation

calcPreferredSize()

Dimension grammarscope.editor.component.BalloonTip.calcPreferredSize ( )

private

Calculate preferred size

Returns

text component's preferred size

calcWhere()

Point grammarscope.editor.component.BalloonTip.calcWhere ( )

private

Compute location

Returns

location to place balloon

setText()

void grammarscope.editor.component.BalloonTip.setText

(

final String

text

)

Set text

Parameters

text

text

setVisible()

synchronized void grammarscope.editor.component.BalloonTip.setVisible

(

final boolean

show

)

Member Data Documentation

alignment

final Alignment grammarscope.editor.component.BalloonTip.alignment

private

Balloon's alignment

attachedComponent

final Component grammarscope.editor.component.BalloonTip.attachedComponent

private

Balloon's external attached component

backcolor

final Color grammarscope.editor.component.BalloonTip.backcolor = new Color(255, 255, 200)

staticprivate

Back color

component

final JComponent grammarscope.editor.component.BalloonTip.component

private

Balloon's internal main component

defaultCloseIcon

final Icon grammarscope.editor.component.BalloonTip.defaultCloseIcon = new ImageIcon(BalloonTip.class.getResource("images/close_default.png"))

staticprivate

Close icon

editingBorder

final Border grammarscope.editor.component.BalloonTip.editingBorder

staticprivate

Initial value:

= BorderFactory
                        .createTitledBorder(BorderFactory.createLineBorder(Color.BLACK), "compiled", TitledBorder.CENTER, TitledBorder.BELOW_TOP,
                                        new Font(Font.DIALOG, Font.BOLD, 12), Color.BLACK)

Border

H_SHRINK

final int grammarscope.editor.component.BalloonTip.H_SHRINK = 25

staticprivate

horizontalOffset

final int grammarscope.editor.component.BalloonTip.horizontalOffset

private

Horizontal position offset

label

final String grammarscope.editor.component.BalloonTip.label

private

Label

popup

Popup grammarscope.editor.component.BalloonTip.popup

private

Popup window

pressedCloseIcon

final Icon grammarscope.editor.component.BalloonTip.pressedCloseIcon = new ImageIcon(BalloonTip.class.getResource("images/close_pressed.png"))

staticprivate

Pressed close icon

rolloverCloseIcon

final Icon grammarscope.editor.component.BalloonTip.rolloverCloseIcon = new ImageIcon(BalloonTip.class.getResource("images/close_rollover.png"))

staticprivate

Rollover close icon

serialVersionUID

final long grammarscope.editor.component.BalloonTip.serialVersionUID = 1L

staticprivate

textComponent

final JTextComponent grammarscope.editor.component.BalloonTip.textComponent

private

Balloon's internal text component

V_EXPAND

final int grammarscope.editor.component.BalloonTip.V_EXPAND = 10

staticprivate

verticalOffset

final int grammarscope.editor.component.BalloonTip.verticalOffset

private

Vertical position offset

---

The documentation for this class was generated from the following file:

• grammarscope/editor/src/main/java/grammarscope/editor/component/BalloonTip.java