Package org.eclipse.nebula.widgets.collapsiblebuttons

Interface ISettings

All Known Implementing Classes:
AbstractSettings, DefaultSettings
public interface ISettings

  • Method Summary

    Modifier and Type Method Description
    boolean allowButtonResizing()
    Whether buttons can be resized via the resize bar.
    boolean drawBorder()
    Whether to draw a 1 pixel border on the left, right and top side of the ButtonComposite.
    int getButtonHeight()
    Returns the height of a button.
    IButtonPainter getButtonPainter()
    Returns the IButtonPainter to use to paint buttons.
    org.eclipse.swt.graphics.Color getButtonTextColor()
    Returns the Color used for the text on the buttons.
    org.eclipse.swt.graphics.Font getButtonTextFont​(org.eclipse.swt.graphics.Font currentFont)
    Returns the Font to use when drawing text on the buttons.
    int getButtonTextImageSpacing()
    Returns the spacing between the image and the text on a button.
    int getLeftButtonTextSpacing()
    Returns the spacing between the left side border and the text on a button.
    org.eclipse.swt.graphics.Image getOutlook2005ArrowImage()
    Returns the image for the Outlook 2005 styled arrow.
    int getOutlook2005ResizeBarSize()
    Returns the pixel height of the Outlook 2005 resize bar.
    int getOutlook2005ResizeDotNumber()
    Returns the number of dots shown on the resize bar for the Outlook 2005 styled resize bar.
    org.eclipse.swt.graphics.Image getOutlook2007ArrowImage()
    Returns the image for the Outlook 2007 styled arrow.
    int getOutlook2007ResizeBarSize()
    Returns the pixel height of the Outlook 2007 resize bar.
    int getOutlook2007ResizeDotNumber()
    Returns the number of dots shown on the resize bar for the Outlook 2007 styled resize bar.
    int getToolBarLeftSpacer()
    Returns the number of pixels left of an item on the toolbar that the selection area should cover.
    int getToolBarRightSpacer()
    Returns the number of pixels right of an item on the toolbar that the selection area should cover.
    int getToolBarSpacing()
    Returns the number of pixels between each item on the toolbar.
    boolean showToolBar()
    Whether to show the toolbar at the bottom or not.

  • Method Details

    • getButtonHeight

      int getButtonHeight()
      Returns the height of a button.
      Returns:
      Button height. Default is 31.

    • drawBorder

      boolean drawBorder()
      Whether to draw a 1 pixel border on the left, right and top side of the ButtonComposite.
      Returns:
      true if draw border. Default is false.

    • showToolBar

      boolean showToolBar()
      Whether to show the toolbar at the bottom or not.
      Returns:
      true if to show toolbar. Default is true.

    • allowButtonResizing

      boolean allowButtonResizing()
      Whether buttons can be resized via the resize bar.
      Returns:
      true if to allow button resizing. Default is true.

    • getOutlook2005ArrowImage

      org.eclipse.swt.graphics.Image getOutlook2005ArrowImage()
      Returns the image for the Outlook 2005 styled arrow.
      Returns:
      Image

    • getOutlook2007ArrowImage

      org.eclipse.swt.graphics.Image getOutlook2007ArrowImage()
      Returns the image for the Outlook 2007 styled arrow.
      Returns:
      Image

    • getOutlook2005ResizeBarSize

      int getOutlook2005ResizeBarSize()
      Returns the pixel height of the Outlook 2005 resize bar.
      Returns:
      Height in pixels. Default is 7.

    • getOutlook2007ResizeBarSize

      int getOutlook2007ResizeBarSize()
      Returns the pixel height of the Outlook 2007 resize bar.
      Returns:
      Height in pixels. Default is 9.

    • getButtonPainter

      IButtonPainter getButtonPainter()
      Returns the IButtonPainter to use to paint buttons.
      Returns:
      IButtonPainter. Default is DefaultButtonPainter.

    • getOutlook2005ResizeDotNumber

      int getOutlook2005ResizeDotNumber()
      Returns the number of dots shown on the resize bar for the Outlook 2005 styled resize bar.
      Returns:
      Number of dots to show. Default is 9.

    • getOutlook2007ResizeDotNumber

      int getOutlook2007ResizeDotNumber()
      Returns the number of dots shown on the resize bar for the Outlook 2007 styled resize bar.
      Returns:
      Number of dots to show. Default is 5.

    • getButtonTextFont

      org.eclipse.swt.graphics.Font getButtonTextFont​(org.eclipse.swt.graphics.Font currentFont)
      Returns the Font to use when drawing text on the buttons. Font will be disposed after use.
      Parameters:
      currentFont - The current font that it is recommended to modify and return
      Returns:
      Font to use. Default is a bold font.

    • getButtonTextColor

      org.eclipse.swt.graphics.Color getButtonTextColor()
      Returns the Color used for the text on the buttons.
      Returns:
      Color. Default is R32 G77 B137.

    • getToolBarSpacing

      int getToolBarSpacing()
      Returns the number of pixels between each item on the toolbar.
      Returns:
      Pixel spacing. Default is 8.

    • getToolBarLeftSpacer

      int getToolBarLeftSpacer()
      Returns the number of pixels left of an item on the toolbar that the selection area should cover.
      Returns:
      Pixel number.

    • getToolBarRightSpacer

      int getToolBarRightSpacer()
      Returns the number of pixels right of an item on the toolbar that the selection area should cover.
      Returns:
      Pixel number.

    • getLeftButtonTextSpacing

      int getLeftButtonTextSpacing()
      Returns the spacing between the left side border and the text on a button.
      Returns:
      pixels spacing. Default is 4.

    • getButtonTextImageSpacing

      int getButtonTextImageSpacing()
      Returns the spacing between the image and the text on a button.
      Returns:
      pixels spacing. Default is 5.