|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.gnu.glib.GObject | +--org.gnu.gtk.GtkObject | +--org.gnu.gtk.Widget | +--org.gnu.gtk.Misc | +--org.gnu.gtk.Label
The Label widget displays a small amount of text. As the name implies, most labels are used to label another widget such as a Button, a MenuItem, or a OptionMenu.
Labels may contain mnemonics. Mnemonics are underlined characters in the label, used for keyboard navigation. Mnemonics are created by providing a string with an underscore before the mnemonic character, such as "_File", to the constructor or setText method, with the hadMnemonic parameter true.
Mnemonics automatically activate any activatable widget the label is inside, such as a Button; if the label is not inside the mnemonic's target widget, you have to tell the label about the target using setMnemonicWidget.
To make it easy to format text in a label (changing colors, fonts, etc.), label text can be provided in a simple markup format. Here's how to create a label with a small font:
label = new Label(""); label.setMarkup("Small text");(See complete documentation of available tags in the Pango manual.)
The markup passed to setMarkup must be valid; for example, literal </>/& characters must be escaped as <, >, and &. If you pass text obtained from the user, file, or a network to setMarkup, you'll want to escape it with g_markup_escape_text().
Markup strings are just a convenient way to set the PangoAttrList on a label; setAttributes may be a simpler way to set attributes in some cases. Be careful though; PangoAttrList tends to cause internationalization problems, unless you're applying attributes to the entire string . The reason is that specifying the startIndex and endIndex for a PangoAttribute requires knowledge of the exact string being displayed, so translations will cause problems.
Labels can be made selectable with setSelectable. Selectable labels allow the user to copy the label contents to the clipboard. Only labels that contain useful-to-copy information - such as error messages - should be made selectable.
A label can contain any number of paragraphs, but will have performance problems if it contains more than a small number. Paragraphs are separated by newlines or other paragraph separators understood by Pango.
Labels can automatically wrap text if you call setLineWrap.
setJustify sets how the lines in a label align with one another. If you want to set how the label as a whole aligns in its available space, see gtk.Misc.setAlignment.
Constructor Summary | |
Label(int handle)
Construct a label using a handle to a native resource. |
|
Label(java.lang.String caption)
Creates a new label widget displaying the given caption. |
|
Label(java.lang.String caption,
boolean hasMnemonic)
Creates a new label widget displaying the given caption. |
Method Summary | |
AttrList |
getAttributes()
Gets the attribute list that was set on the label using setAttributes, if any. |
Justification |
getJustification()
Returns the justification of the label. |
java.lang.String |
getLabel()
Fetches the text from a label widget including any embedded underlines indicating mnemonics and Pango markup. |
boolean |
getLineWrap()
Returns whether lines in the label are automatically wrapped. |
Widget |
getMnemonicWidget()
Retrieves the target of the mnemonic (keyboard shortcut) of this label |
boolean |
getSelectable()
Gets the value set by setSelectable. |
boolean |
getSelected()
Returns true if any part of the label is selected |
int |
getSelectionEnd()
Returns the index of the end of the selected test. |
int |
getSelectionStart()
Returns the index of the start of the selected text. |
java.lang.String |
getText()
Returns the text which is being displayed on this label. |
static Type |
getType()
Retrieve the runtime type used by the GLib library. |
boolean |
getUseMarkup()
Returns whether the label's text is interpreted as marked up with the Pango text markup language. |
boolean |
getUseMnemonic()
Returns whether an embedded underline in the label indicates a mnemonic. |
void |
select(int startOffset,
int endOffset)
Selects a range of characters in the label, if the label is selectable. |
void |
setAttributes(AttrList attributes)
Sets a PangoAttrList; the attributes in the list are applied to the label text. |
void |
setJustification(Justification justification)
Sets the alignment of the lines in the text of the label relative to each other. |
void |
setLabel(java.lang.String label)
Sets the text of the label. |
void |
setLineWrap(boolean wrap)
Toggles line wrapping within the Label widget. |
void |
setMarkup(java.lang.String markup)
Parses markup which is marked up with the Pango text markup
language, setting the label's text and attribute list based on the
parse results. |
void |
setMarkup(java.lang.String markup,
boolean hasMnemonic)
Parses markup which is marked up with the Pango text markup
language, setting the label's text and attribute list based on the
parse results. |
void |
setMnemonicWidget(Widget widget)
If the label has been set so that it has an mnemonic key, the label can be associated with a widget that is the target of the mnemonic. |
void |
setSelectable(boolean setting)
Selectable labels allow the user to select text from the label, for copy-and-paste. |
void |
setText(java.lang.String caption)
Changes the text to be displayed in the label widget. |
void |
setUnderlinePattern(java.lang.String pattern)
The pattern of underlines you want under the existing text within the Label widget. |
void |
setUseMarkup(boolean setting)
Sets whether the text of the label contains markup in Pango's text markup language. |
void |
setUseMnemonic(boolean setting)
If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. |
Methods inherited from class org.gnu.gtk.Misc |
getXAlign, getXPadding, getYAlign, getYPadding, setAlignment, setPadding |
Methods inherited from class org.gnu.glib.GObject |
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, equals, getData, getHandle, removeEventHandler, setData |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Label(java.lang.String caption)
caption
- The default text to be displayed on the labelpublic Label(java.lang.String caption, boolean hasMnemonic)
caption
- The default text to be displayed on the labelhasMnemonic
- If true, the caption is interpreted to have mnemonic
characters. See the description for this class for more details.public Label(int handle)
Method Detail |
public void setText(java.lang.String caption)
caption
- the new text to be displayed.public java.lang.String getText()
public void setAttributes(AttrList attributes)
attributes
- Pange attrlist attributes to useAttrList
public AttrList getAttributes()
public void setLabel(java.lang.String label)
label
- The new text to set for the labelpublic java.lang.String getLabel()
public void setMarkup(java.lang.String markup)
markup
which is marked up with the Pango text markup
language, setting the label's text and attribute list based on the
parse results. The markup should not contain mnemonic characters if this
method is used.
markup
- String containg pango markuppublic void setMarkup(java.lang.String markup, boolean hasMnemonic)
markup
which is marked up with the Pango text markup
language, setting the label's text and attribute list based on the
parse results.
markup
- String containg pango markuphasMnemonic
- If True, the markup string will be interpreted to
contain mnemonic characters, for use as keyboard acceleratorspublic void setUseMarkup(boolean setting)
setting
- TRUE if the label's text should be parsed for markup.setMarkup(String, boolean)
public boolean getUseMarkup()
setUseMarkup(boolean)
public boolean getUseMnemonic()
setUseMnemonic(boolean)
public void setUseMnemonic(boolean setting)
setting
- TRUE if underlines in the text indicate mnemonicspublic void setMnemonicWidget(Widget widget)
The target widget will be accelerated by emitting "mnemonic_activate" on it. The default handler for this signal will activate the widget if there are no mnemonic collisions and toggle focus between the colliding widgets otherwise.
widget
- The target widgetpublic Widget getMnemonicWidget()
public void setJustification(Justification justification)
public Justification getJustification()
setJustification(Justification)
public void setUnderlinePattern(java.lang.String pattern)
pattern
- The pattern as described above.public void setLineWrap(boolean wrap)
wrap
- New line wrap setting.public boolean getLineWrap()
public void setSelectable(boolean setting)
setting
- TRUE to allow selecting text in the labelpublic boolean getSelectable()
public void select(int startOffset, int endOffset)
startOffset
- The start offset in charactersendOffset
- The end offset in characterssetSelectable(boolean)
public boolean getSelected()
public int getSelectionStart()
public int getSelectionEnd()
public static Type getType()
|
Please send any bug reports, comments, or suggestions for the API or documentation to java-gnome-developer@lists.sf.net | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |