Eclipse RSE Development Guide (Galileo) - SystemCollapsableSection (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.ui.widgets
Class SystemCollapsableSection


java.lang.Object
  

org.eclipse.swt.widgets.Widget
      

org.eclipse.swt.widgets.Control
          

org.eclipse.swt.widgets.Scrollable
              

org.eclipse.swt.widgets.Composite
                  
org.eclipse.rse.ui.widgets.SystemCollapsableSection

All Implemented Interfaces:: EventListener, MouseListener, PaintListener, Drawable, org.eclipse.swt.internal.SWTEventListener

public class SystemCollapsableSection
extends Composite
implements MouseListener, PaintListener
extends Composite
implements MouseListener, PaintListener

Class to provide a collapsible composite that can be collapsed to hide some controls

Nested Class Summary

protected class SystemCollapsableSection.RTwisteeLayout


Field Summary

protected boolean _bCollapsed


protected boolean _bMouseOver


protected static Color _colorCollapsable


protected Composite _compositePage


protected Label _labelTitle


protected String _strCollapsedText


protected String _strCollapsedToolTip


protected String _strExpandedText


protected String _strExpandedToolTip


protected String _strText


static String Copyright


Fields inherited from class org.eclipse.swt.widgets. Composite

embeddedHandle

Fields inherited from class org.eclipse.swt.widgets. Widget

handle

Constructor Summary

SystemCollapsableSection ( Composite compositeParent)
          Constructor

Method Summary

void addCollapseListener ( ISystemCollapsableSectionListener listener)
          Add a collapse / expand event listener

boolean getCollapsed ()
          Return the collapse state

Composite getPageComposite ()
          Get the actual composite inside the collapsible section to be usde for filling it up with controls

String getText ()
          Get the default title text

void mouseDoubleClick ( MouseEvent e)


void mouseDown ( MouseEvent e)


void mouseUp ( MouseEvent e)
          Handle the collapse or expand request from the mouse up event

static void paintCollapsable ( GC gc, int iX, int iY, boolean bCollapsed)
          Paints the two states of a collapsable indicator of a collapsable container.

void paintControl ( PaintEvent e)
          Paint the control

void removeCollapseListener ( ISystemCollapsableSectionListener listener)
          Remove a collapse / expand event listener

void setCollapsed (boolean bCollapsed)
          Set the section to be collapsed

void setCollapsedText ( String strText)
          Set the title to be displayed when the section is collapsed

void setExpandedText ( String strText)
          Set the title to be displayed when the section is expanded

void setText ( String strText)
          Set the default text title

void setToolTips ( String strExpandedToolTip, String strCollapsedToolTip)
          Sets tooltips used in expanded and collapsed states.

Methods inherited from class org.eclipse.swt.widgets. Composite

changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets. Scrollable

computeTrim, getBorderWidth, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets. Control

addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getData, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets. Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Copyright

public static final 
String Copyright

See Also:: Constant Field Values

_bCollapsed

protected boolean _bCollapsed

_bMouseOver

protected boolean _bMouseOver

_compositePage

protected 
Composite _compositePage

_strText

protected 
String _strText

_strExpandedText

protected 
String _strExpandedText

_strCollapsedText

protected 
String _strCollapsedText

_strExpandedToolTip

protected 
String _strExpandedToolTip

_strCollapsedToolTip

protected 
String _strCollapsedToolTip

_labelTitle

protected 
Label _labelTitle

_colorCollapsable

protected static 
Color _colorCollapsable

Constructor Detail

SystemCollapsableSection

public SystemCollapsableSection(
Composite compositeParent)

Constructor

Method Detail

getPageComposite

public 
Composite getPageComposite()

Get the actual composite inside the collapsible section to be usde for filling it up with controls

getCollapsed

public boolean getCollapsed()

Return the collapse state

getText

public 
String getText()

Get the default title text

mouseDoubleClick

public void mouseDoubleClick(
MouseEvent e)

Specified by:: mouseDoubleClick in interface MouseListener

mouseDown

public void mouseDown(
MouseEvent e)

Specified by:: mouseDown in interface MouseListener

mouseUp

public void mouseUp(
MouseEvent e)

Handle the collapse or expand request from the mouse up event

Specified by:: mouseUp in interface MouseListener

paintControl

public void paintControl(
PaintEvent e)

Paint the control

Specified by:: paintControl in interface PaintListener

paintCollapsable

public static void paintCollapsable(
GC gc,
                                    int iX,
                                    int iY,
                                    boolean bCollapsed)

Paints the two states of a collapsable indicator of a collapsable container.

setCollapsed

public void setCollapsed(boolean bCollapsed)

Set the section to be collapsed

setText

public void setText(
String strText)

Set the default text title

setExpandedText

public void setExpandedText(
String strText)

Set the title to be displayed when the section is expanded

setCollapsedText

public void setCollapsedText(
String strText)

Set the title to be displayed when the section is collapsed

setToolTips

public void setToolTips(
String strExpandedToolTip,
                        
String strCollapsedToolTip)

Sets tooltips used in expanded and collapsed states.

Parameters:: strExpandedToolTip - tooltip for the expanded state. For example, "click line to collapse the section".; strCollapsedToolTip - tooltip for the collapsed state. For example, "click line to expand the section".

addCollapseListener

public void addCollapseListener(
ISystemCollapsableSectionListener listener)

Add a collapse / expand event listener

removeCollapseListener

public void removeCollapseListener(
ISystemCollapsableSectionListener listener)

Remove a collapse / expand event listener