Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - DrawerEntryPage (Eclipse GEF API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse GEF
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gef.ui.palette.customize
Class DrawerEntryPage

java.lang.Object
  

org.eclipse.gef.ui.palette.customize.DefaultEntryPage
      
org.eclipse.gef.ui.palette.customize.DrawerEntryPage

All Implemented Interfaces:: EntryPage

public class DrawerEntryPage
extends DefaultEntryPage

The default entry page for drawers.

Constructor Summary

DrawerEntryPage ()


Method Summary

void createControl (Composite parent, PaletteEntry entry)
          Creates the Control that displays the properties of the given entry.

protected Button createOpenDrawerInitiallyOption (Composite panel)
          Creates the button that provides the option to pin a drawer open at start-up.

protected Button createPinDrawerInitiallyOption (Composite panel)
          Creates the button that provides the option to have a drawer open at start-up.

protected PaletteDrawer getDrawer ()
          Convenience method that provides access to the PaletteDrawer.

protected Button getOpenDrawerInitiallyButton ()
          Returns the checkbox button which controls whether the drawer is initially open.

protected Button getPinDrawerInitiallyButton ()
          Returns the checkbox button which controls whether the drawer is initially pinned.

protected void handleOpenSelected (boolean selection)
          This method is invoked when the selection state of the option to open drawer at start-up is toggled.

protected void handlePinSelected (boolean selection)
          This method is invoked when the selection state of the option to pin a drawer open at start-up is toggled.

Methods inherited from class org.eclipse.gef.ui.palette.customize. DefaultEntryPage

apply, createDescText, createHiddenCheckBox, createLabel, createNameText, createText, getControl, getEntry, getMessage, getPageContainer, getPermission, handleDescriptionChanged, handleHiddenSelected, handleNameChanged, setPageContainer

Methods inherited from class java.lang.Object

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

Constructor Detail

DrawerEntryPage

public DrawerEntryPage()

Method Detail

createControl

public void createControl(Composite parent,
                          
PaletteEntry entry)

Description copied from interface: EntryPage

Creates the Control that displays the properties of the given entry. This method will only be called once. The parent Composite's Font is set to the Workbench Dialog Font. The page's Controls should use the Workbench Dialog Font where appropriate.

Specified by:: createControl in interface EntryPage
Overrides:: createControl in class DefaultEntryPage

See Also:: EntryPage.createControl(Composite, PaletteEntry)

createOpenDrawerInitiallyOption

protected Button createOpenDrawerInitiallyOption(Composite panel)

Creates the button that provides the option to pin a drawer open at start-up.

Parameters:: panel - The parent Composite
Returns:: The button for the new option

createPinDrawerInitiallyOption

protected Button createPinDrawerInitiallyOption(Composite panel)

Creates the button that provides the option to have a drawer open at start-up.

Parameters:: panel - The parent Composite
Returns:: The button for the new option

getDrawer

protected 
PaletteDrawer getDrawer()

Convenience method that provides access to the PaletteDrawer.

Returns:: the entry as a PaletteDrawer

getOpenDrawerInitiallyButton

protected Button getOpenDrawerInitiallyButton()

Returns the checkbox button which controls whether the drawer is initially open.

Returns:: the checkbox button which controls the initially open setting.

getPinDrawerInitiallyButton

protected Button getPinDrawerInitiallyButton()

Returns the checkbox button which controls whether the drawer is initially pinned.

Returns:: the checkbox button which controls the initially pinned setting.

handleOpenSelected

protected void handleOpenSelected(boolean selection)

This method is invoked when the selection state of the option to open drawer at start-up is toggled.

It sets the initial state of the drawer accordingly.

Parameters:: selection - true if that option is now selected

handlePinSelected

protected void handlePinSelected(boolean selection)

This method is invoked when the selection state of the option to pin a drawer open at start-up is toggled.