All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.wildcrest.jmultilinelabel.JMultiLineLabel

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----javax.swing.JComponent
                           |
                           +----com.wildcrest.jmultilinelabel.JMultiLineLabel

public class JMultiLineLabel

extends JComponent

implements Accessible

labelFor

--- Accessibility Support ---

JMultiLineLabel()

Construct a JMultiLineLabel object with an empty label and default width

JMultiLineLabel(String)

Construct a JMultiLineLabel object with the specified string as the label

JMultiLineLabel(String, int)

Construct a JMultiLineLabel object with the specified string as the label and with initial width in pixels

addPropertyChangeListener(PropertyChangeListener)

getAccessibleContext()

Get the AccessibleContext of this object

getBottomInset()

Returns the bottom inset of the label.

getCopyright()

getLabelFor()

Get the component this is labelling.

getLabelWidth()

Returns the width of the component.

getLeftInset()

Returns the left inset of the label.

getLineSpacing()

Returns the line spacing for the label.

getMinimumSize()

Returns the minimum size for displaying this component.

getPixelsPerTab()

Returns the pixels per tab stop for the label.

getPreferredSize()

Returns the recommended size for displaying this component.

getRightInset()

Returns the right inset of the label.

getTabStops()

Returns the tab stop positions in pixels.

getText()

Returns the label's text string.

getTopInset()

Returns the top inset of the label.

getWrap()

Returns whether automatic line wrapping is enabled or disabled.

minimumSize()

Deprecated.

paint(Graphics)

Paints the JMultiLineLabel component using the given graphics context

preferredSize()

Deprecated.

removePropertyChangeListener(PropertyChangeListener)

setBottomInset(int)

Sets the bottom inset in pixels.

setBounds(int, int, int, int)

Moves and resizes this component.

setCopyright(String)

setLabelFor(Component)

Set the component this is labelling.

setLabelWidth(int)

Sets width of the label.

setLeftInset(int)

Sets the left inset in pixels.

setLineSpacing(double)

Sets the line spacing, in multiples of fontHeight.

setLocation(int, int)

Set location for this component.

setPixelsPerTab(int)

Sets the pixels per tab stop.

setRightInset(int)

Sets the right inset in pixels.

setSize(int, int)

Resizes this component.

setTabStops(int[])

Sets tab stops.

setText(String)

Sets the text label.

setTopInset(int)

Sets the top inset in pixels.

setWrap(boolean)

Sets whether automatic line wrap is enabled or disabled.

updateUI()

Notification from UIFractory that the L&F has changed, JMultiLineLabel simply reuses the JLabel look and feel elements for foreground color, background color, and font

 protected Component labelFor

--- Accessibility Support ---

 public JMultiLineLabel(String string,
                        int width)

Construct a JMultiLineLabel object with the specified string as the label and with initial width in pixels

 public JMultiLineLabel(String string)

Construct a JMultiLineLabel object with the specified string as the label

 public JMultiLineLabel()

Construct a JMultiLineLabel object with an empty label and default width

 public void setText(String str)

Sets the text label. Can have embedded line.separators to indicate hard line boundaries or can rely on line wrapping feature to break lines. Also can have embedded tabs.

Parameters:

string - a string specifying the text of the JMultiLineLabel, which may (or may not) have embedded line.separators and tabs

 public synchronized String getText()

Returns the label's text string.

 public void setPixelsPerTab(int pixelsPerTab)

Sets the pixels per tab stop.

Parameters:

pixelsPerTab - pixels per tab stop. Default: 40

 public synchronized int getPixelsPerTab()

Returns the pixels per tab stop for the label.

 public void setTabStops(int tabStops[])

Sets tab stops.

Parameters:

tabStops[] - tab stop positions in pixels. Default: 40, 80, 120, ...

 public synchronized int[] getTabStops()

Returns the tab stop positions in pixels.

 public void setLineSpacing(double lineSpacing)

Sets the line spacing, in multiples of fontHeight.

Parameters:

lineSpacing - in multiples of fontHeight (1.0 = single spacing, 2.0 = double spacing, etc.) Default: 1.0

 public synchronized double getLineSpacing()

Returns the line spacing for the label.

 public void setLeftInset(int leftInset)

Sets the left inset in pixels.

Parameters:

leftInset - left inset in pixels. Default: 0

 public synchronized int getLeftInset()

Returns the left inset of the label.

 public void setRightInset(int rightInset)

Sets the right inset in pixels.

Parameters:

rightInset - right inset in pixels. Default: 0

 public synchronized int getRightInset()

Returns the right inset of the label.

 public void setTopInset(int topInset)

Sets the top inset in pixels.

Parameters:

topInset - top inset in pixels. Default: 0

 public synchronized int getTopInset()

Returns the top inset of the label.

 public void setBottomInset(int bottomInset)

Sets the bottom inset in pixels.

Parameters:

bottomInset - bottom inset in pixels. Default 0

 public synchronized int getBottomInset()

Returns the bottom inset of the label.

 public void setWrap(boolean wrap)

Sets whether automatic line wrap is enabled or disabled.

Parameters:

wrap - whether automatic line wrap is enabled or disabled. Default: true

 public synchronized boolean getWrap()

Returns whether automatic line wrapping is enabled or disabled.

 public void setLabelWidth(int width)

Sets width of the label.

Parameters:

width - width of the label in pixels. Default: 150

 public synchronized int getLabelWidth()

Returns the width of the component.

 public void setCopyright(String str)

 public synchronized String getCopyright()

 public void addPropertyChangeListener(PropertyChangeListener listener)

Overrides:

addPropertyChangeListener in class JComponent

 public void removePropertyChangeListener(PropertyChangeListener listener)

Overrides:

removePropertyChangeListener in class JComponent

 public void paint(Graphics g)

Paints the JMultiLineLabel component using the given graphics context

Parameters:

g - the graphics context used for painting the component

Overrides:

paint in class JComponent

 public Dimension getPreferredSize()

Returns the recommended size for displaying this component. Width is left unchanged, height is the size needed to display all the lines of text.

Overrides:

getPreferredSize in class JComponent

See Also:

getMinimumSize

 public Dimension preferredSize()

Note: preferredSize() is deprecated.

Overrides:

preferredSize in class Container

See Also:

getPreferredSize

 public Dimension getMinimumSize()

Returns the minimum size for displaying this component. Width is left unchange, height is the size needed to display all the lines of text.

Overrides:

getMinimumSize in class JComponent

See Also:

getPreferredSize

 public Dimension minimumSize()

Note: minimumSize() is deprecated.

Overrides:

minimumSize in class Container

See Also:

getMinimumSize

 public synchronized void setBounds(int x,
                                    int y,
                                    int width,
                                    int height)

Moves and resizes this component. Causes rewrap of text.

Parameters:

x - horizontal position in parent container's coordinates

y - vertical position in parent container's coordinates

width - desired width in pixels

height - desired height in pixels

Overrides:

setBounds in class Component

 public synchronized void setSize(int width,
                                  int height)

Resizes this component. Causes rewrap of text.

Parameters:

width - desired width in pixels

height - desired height in pixels

Overrides:

setSize in class Component

 public synchronized void setLocation(int x,
                                      int y)

Set location for this component. Causes rewrap of text.

Parameters:

x - desired x coordinate

y - desired y coordinate

Overrides:

setLocation in class Component

 public AccessibleContext getAccessibleContext()

Get the AccessibleContext of this object

Returns:

the AccessibleContext of this object

Overrides:

getAccessibleContext in class JComponent

 public Component getLabelFor()

Get the component this is labelling.

Returns:

the Component this is labelling. Can be null if this does not label a Component. If the displayedMnemonic property is set and the labelFor property is also set, the label will call the requestFocus method of the component specified by the labelFor property when the mnemonic is activated.

See Also:

getDisplayedMnemonic, setDisplayedMnemonic

 public void setLabelFor(Component c)

Set the component this is labelling. Can be null if this does not label a Component. If the displayedMnemonic property is set and the labelFor property is also set, the label will call the requestFocus method of the component specified by the labelFor property when the mnemonic is activated.

Parameters:

c - the Component this label is for, or null if the label is not the label for a component

See Also:

getDisplayedMnemonic, setDisplayedMnemonic

 public void updateUI()

Notification from UIFractory that the L&F has changed, JMultiLineLabel simply reuses the JLabel look and feel elements for foreground color, background color, and font

Overrides:

updateUI in class JComponent

All Packages  Class Hierarchy  This Package  Previous  Next  Index