org.gnu.pango
public class Layout extends GObject
Deprecated: This class is part of the java-gnome 2.x family of libraries,
which, due to their inefficiency and complexity, are no longer
being maintained and have been abandoned by the java-gnome
project. This class may exist in java-gnome 4.0; look out for
org.gnome.pango.Layout
.
As this package was never fully implemented in java-gnome 2.x,
however, any new code written will have a considerably different
public API.
The PangoLayout structure represents and entire paragraph of text. It is initialized with a PangoContext, UTF-8 string and set of attributes for that string. Once that is done, the set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout's text, and the physical position of the resulting glyphs can be made.
Constructor Summary | |
---|---|
Layout(Context context)
Construct a new Layout with the given Context.
| |
Layout(Layout layout)
Construct a new Layout that is a copy of the provided Layout.
| |
Layout(Handle handle)
Construct a new Layout with a handle that has been returned from a native
call.
|
Method Summary | |
---|---|
void | contextChanged()
Forces recomputation of any state in the Layout that might depend on the
layout's context. |
Alignment | getAlignment()
Gets the alignment for the layout (how partial lines are positioned
within the horizontal space available.) |
AttrList | getAttributes()
Gets the attribute list for the layout, if any |
Context | getContext()
Retrieve the Context used for this Layout. |
int | getHeight()
Return the logical height of the Layout in Pango units. |
int | getIndent()
Gets the amount by which the first line should be shorter than the rest
of the lines. |
boolean | getJustified()
Gets whether or not each complete line should be stretched to fill the
entire width of the layout.
|
boolean | getJustify()
Gets whether or not each complete line should be stretched to fill the
entire width of the layout. |
static Layout | getLayoutFromHandle(Handle handle)
Static factory method that should only be used interally by Java-Gnome. |
LayoutLine | getLine(int line)
Retrieves a particular line from a Layout.
|
int | getLineCount()
Retrieve the count of lines for the layout |
int | getPixelHeight()
Return the logical height of the Layout in device units. |
int | getPixelWidth()
Return the logical width of the Layout in device units. |
boolean | getSingleParagraphMode()
Obtains the value set by Layout. |
int | getSpacing()
Gets the amount of spacing between the lines of the layout.
|
Rectangle | getStrongCursorPosition(int index)
Given an index within a layout, determines the positions that of the
strong cursor if the insertion point is at that index. |
TabArray | getTabs()
Gets the current TabArray used by this layout. |
String | getText()
Gets the text in the layout. |
Rectangle | getWeakCursorPosition(int index)
Given an index within a layout, determines the positions that of the weak
cursor if the insertion point is at that index. |
int | getWidth()
Gets the width to which the lines of the PangoLayout should be wrapped. |
WrapMode | getWrap()
Get the wrap mode for the layout. |
WrapMode | getWrapMode()
Get the wrap mode for the layout.
|
Rectangle | indexToPos(int index)
Converts from an index within a Layout to the onscreen position
corresponding to the grapheme at that index, which is represented as
rectangle. |
void | setAlignment(Alignment alignment)
Sets the alignment for the layout (how partial lines are positioned
within the horizontal space available.) |
void | setAttributes(AttrList attributes)
Sets the text attributes for a layout object |
void | setFontDescription(FontDescription desc)
Set the default font description for the layout. |
void | setIndent(int indent)
Sets the amount by which the first line should be shorter than the rest
of the lines. |
void | setJustification(boolean justify)
Sets whether or not each complete line should be stretched to fill the
entire width of the layout. |
void | setJustify(boolean justify)
Sets whether or not each complete line should be stretched to fill the
entire width of the layout. |
void | setMarkup(String markup, char accelMarker)
Sets the layout text and attribute list from marked-up text (see markup
format). |
void | setMarkup(String markup)
Same as Layout, but the markup text isn't
scanned for accelerators. |
void | setSingleParagraphMode(boolean setting)
If setting is TRUE, do not treat newlines and similar characters as
paragraph separators; instead, keep all text in a single paragraph, and
display a glyph for paragraph separator characters. |
void | setSpacing(int spacing)
Sets the amount of spacing between the lines of the layout. |
void | setTabs(TabArray tabs)
Sets the tabs to use for layout, overriding the default tabs (by default,
tabs are every 8 spaces). |
void | setText(String text)
Set the text of the layout. |
void | setWidth(int width)
Sets the width to which the lines of the PangoLayout should be wrapped. |
void | setWrap(WrapMode wrap)
Sets the wrap style; the wrap style only has an effect if a width is set
on the layout with LayoutTo turn off wrapping, set the
width to -1. |
void | setWrapStyle(WrapMode wrap)
Sets the wrap style; the wrap style only has an effect if a width is set
on the layout with LayoutTo turn off wrapping, set the
width to -1.
|
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Construct a new Layout with the given Context.Parameters: context The context to use for the Layout construction.
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Construct a new Layout that is a copy of the provided Layout.Parameters: layout
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Construct a new Layout with a handle that has been returned from a native call.Parameters: handle The handle to the native resource.
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Forces recomputation of any state in the Layout that might depend on the layout's context. This method should be called if you make changes to the context subsequent to creating the layoutDeprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the alignment for the layout (how partial lines are positioned within the horizontal space available.)Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the attribute list for the layout, if anyDeprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Retrieve the Context used for this Layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Return the logical height of the Layout in Pango units.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the amount by which the first line should be shorter than the rest of the lines.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets whether or not each complete line should be stretched to fill the entire width of the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets whether or not each complete line should be stretched to fill the entire width of the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Static factory method that should only be used interally by Java-Gnome.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Retrieves a particular line from a Layout.Parameters: line the index of a line, which must be between 0 and pango_layout_get_line_count(layout) - 1, inclusive.
Returns: the requested LayoutLine.
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Retrieve the count of lines for the layoutDeprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Return the logical height of the Layout in device units.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Return the logical width of the Layout in device units.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Obtains the value set by Layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the amount of spacing between the lines of the layout.Returns: the spacing (in thousandths of a device unit)
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Given an index within a layout, determines the positions that of the strong cursor if the insertion point is at that index. The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted.Parameters: index
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the current TabArray used by this layout. If no TabArray has been set, then the default tabs are in use and null is returned. Default tabs are every 8 spaces.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the text in the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Given an index within a layout, determines the positions that of the weak cursor if the insertion point is at that index. The position of each cursor is stored as a zero-width rectangle. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.Parameters: index
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Gets the width to which the lines of the PangoLayout should be wrapped.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Get the wrap mode for the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Get the wrap mode for the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Converts from an index within a Layout to the onscreen position corresponding to the grapheme at that index, which is represented as rectangle. Note that pos->x is always the leading edge of the grapheme and pos->x + pos->width the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then pos->width will be negative.Parameters: index
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.)Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the text attributes for a layout objectDeprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Set the default font description for the layout. If no font description is set on the layout, the font description from the layout's context is used.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the amount by which the first line should be shorter than the rest of the lines. This may be negative, in which case the subsequent lines will be shorter than the first line. (However, in either case, the entire width of the layout will be given by the valueDeprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets whether or not each complete line should be stretched to fill the entire width of the layout. This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets whether or not each complete line should be stretched to fill the entire width of the layout. This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.If accelMarker is nonzero, the given character will mark the character following it as an accelerator. For example, the accel marker might be an ampersand or underscore. All characters marked as an accelerator will receive a LOW attribute. Two accelMarker characters following each other produce a single literal accelMarker character.
Parameters: markup some marked-up text accelMarker : marker for accelerators in the text
Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Same as Layout, but the markup text isn't scanned for accelerators.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
If setting is TRUE, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the amount of spacing between the lines of the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the tabs to use for layout, overriding the default tabs (by default, tabs are every 8 spaces).Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Set the text of the layout.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the width to which the lines of the PangoLayout should be wrapped.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the wrap style; the wrap style only has an effect if a width is set on the layout with LayoutTo turn off wrapping, set the width to -1.Deprecated: Superceeded by java-gnome 4.0; this method or constant will no doubt exist conceptually, but it may have a different name or signature in order that the presented API is an algorithmic mapping of the underlying native libraries.
Sets the wrap style; the wrap style only has an effect if a width is set on the layout with LayoutTo turn off wrapping, set the width to -1.