org.gnu.pango
Class Layout

java.lang.Object
  extended by org.gnu.glib.Struct
      extended by org.gnu.glib.GObject
          extended by org.gnu.pango.Layout

public class Layout
extends GObject

While complete access to the layout capabilities of Pango is provided using the detailed interfaces for itemization and shaping, using that functionality directly involves writing a fairly large amount of code. The objects and functions in this structure provide a high-level driver for formatting entire paragraphs of text at once.

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(org.gnu.glib.Handle handle)
          Construct a new Layout with a handle that has been returned from a native call.
Layout(Layout layout)
          Construct a new Layout that is a copy of the provided Layout.
 
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()
          Deprecated.  
 boolean getJustify()
          Gets whether or not each complete line should be stretched to fill the entire width of the layout.
static Layout getLayoutFromHandle(org.gnu.glib.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 setSingleParagraphMode(boolean).
 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.
 java.lang.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()
          Deprecated.  
 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)
          Deprecated.  
 void setJustify(boolean justify)
          Sets whether or not each complete line should be stretched to fill the entire width of the layout.
 void setMarkup(java.lang.String markup)
          Same as setMarkup(String, char), but the markup text isn't scanned for accelerators.
 void setMarkup(java.lang.String markup, char accelMarker)
          Sets the layout text and attribute list from marked-up text (see markup format).
 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(java.lang.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 setWidth(int)To turn off wrapping, set the width to -1.
 void setWrapStyle(WrapMode wrap)
          Deprecated.  
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, collect, freezeNotify, getBooleanProperty, getData, getDoubleProperty, getEventListenerClass, getEventType, getFloatProperty, getGObjectFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getPixbufProperty, getProperty, getStringProperty, hasProperty, notify, removeEventHandler, removeListener, setBooleanProperty, setData, setDoubleProperty, setFloatProperty, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify
 
Methods inherited from class org.gnu.glib.Struct
equals, getHandle, getNullHandle, hashCode
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Layout

public Layout(Context context)
Construct a new Layout with the given Context.

Parameters:
context - The context to use for the Layout construction.

Layout

public Layout(Layout layout)
Construct a new Layout that is a copy of the provided Layout.

Parameters:
layout -

Layout

public Layout(org.gnu.glib.Handle handle)
Construct a new Layout with a handle that has been returned from a native call.

Parameters:
handle - The handle to the native resource.
Method Detail

getLayoutFromHandle

public static Layout getLayoutFromHandle(org.gnu.glib.Handle handle)
Static factory method that should only be used interally by Java-Gnome.


getContext

public Context getContext()
Retrieve the Context used for this Layout.


contextChanged

public void contextChanged()
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 layout


setText

public void setText(java.lang.String text)
Set the text of the layout.


getText

public java.lang.String getText()
Gets the text in the layout.


setMarkup

public void setMarkup(java.lang.String markup,
                      char accelMarker)
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 Underline.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

setMarkup

public void setMarkup(java.lang.String markup)
Same as setMarkup(String, char), but the markup text isn't scanned for accelerators.


setAttributes

public void setAttributes(AttrList attributes)
Sets the text attributes for a layout object


getAttributes

public AttrList getAttributes()
Gets the attribute list for the layout, if any


setFontDescription

public void setFontDescription(FontDescription desc)
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.


setWidth

public void setWidth(int width)
Sets the width to which the lines of the PangoLayout should be wrapped.


getWidth

public int getWidth()
Gets the width to which the lines of the PangoLayout should be wrapped.


setWrapStyle

public void setWrapStyle(WrapMode wrap)
Deprecated. 

Sets the wrap style; the wrap style only has an effect if a width is set on the layout with setWidth(int)To turn off wrapping, set the width to -1.


getWrapMode

public WrapMode getWrapMode()
Deprecated. 

Get the wrap mode for the layout.


setWrap

public void setWrap(WrapMode wrap)
Sets the wrap style; the wrap style only has an effect if a width is set on the layout with setWidth(int)To turn off wrapping, set the width to -1.


getWrap

public WrapMode getWrap()
Get the wrap mode for the layout.


setIndent

public void setIndent(int indent)
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 value


getIndent

public int getIndent()
Gets the amount by which the first line should be shorter than the rest of the lines.


getSpacing

public int getSpacing()
Gets the amount of spacing between the lines of the layout.

Returns:
the spacing (in thousandths of a device unit)

setSpacing

public void setSpacing(int spacing)
Sets the amount of spacing between the lines of the layout.


setJustification

public void setJustification(boolean justify)
Deprecated. 

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.


getJustified

public boolean getJustified()
Deprecated. 

Gets whether or not each complete line should be stretched to fill the entire width of the layout.


setJustify

public void setJustify(boolean justify)
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.


getJustify

public boolean getJustify()
Gets whether or not each complete line should be stretched to fill the entire width of the layout.


setAlignment

public void setAlignment(Alignment alignment)
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.)


getAlignment

public Alignment getAlignment()
Gets the alignment for the layout (how partial lines are positioned within the horizontal space available.)


setTabs

public void setTabs(TabArray tabs)
Sets the tabs to use for layout, overriding the default tabs (by default, tabs are every 8 spaces).


getTabs

public TabArray getTabs()
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.


setSingleParagraphMode

public 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. Used when you want to allow editing of newlines on a single text line.


getSingleParagraphMode

public boolean getSingleParagraphMode()
Obtains the value set by setSingleParagraphMode(boolean).


getLineCount

public int getLineCount()
Retrieve the count of lines for the layout


getLine

public LayoutLine getLine(int line)
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.

indexToPos

public 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. 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 -

getStrongCursorPosition

public 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. 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 -

getWeakCursorPosition

public 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. 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 -

getHeight

public int getHeight()
Return the logical height of the Layout in Pango units.


getPixelWidth

public int getPixelWidth()
Return the logical width of the Layout in device units.


getPixelHeight

public int getPixelHeight()
Return the logical height of the Layout in device units.