Class DefaultEntryPage
java.lang.Object
org.eclipse.gef.ui.palette.customize.DefaultEntryPage
- All Implemented Interfaces:
- EntryPage
- Direct Known Subclasses:
- DrawerEntryPage
This is a default implementation of the 
EntryPage interface. It
 displays the entry's label, description and visible fields (and allows for
 their modification). It is live in the sense that the model is updated with
 the changes immediately (on every keystroke).- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionfinal voidapply()Being live, this method is completely ignored.voidcreateControl(Composite parent, PaletteEntry entry) Creates the Control that displays the properties of the given entry.protected TextcreateDescText(Composite panel) Creates theTextwhere the description of the entry is to be displayed.protected ButtoncreateHiddenCheckBox(Composite panel) Creates theButton(CheckBox) for indicating the hidden status of the entry.protected LabelcreateLabel(Composite panel, int style, String text) Creates a labelprotected TextcreateNameText(Composite panel) Creates the Text where the name of the entry is to be displayed.protected TextcreateText(Composite panel, int style, String text) Creates aText.Returns the Panel (Control) that displays the properties of the entry.protected PaletteEntrygetEntry()Provides sub-classes with access to the entry this class is monitoring.protected StringSub-classes should override this method to provide appropriate error notification messages.protected EntryPageContainerprotected intprotected voidUpdates the model with the change in the entry's description, and updates the state of the page.protected voidhandleHiddenSelected(boolean isChecked) Updates the model with the change in the entry's hidden state, and updates the state of the page.protected voidhandleNameChanged(String text) Updates the model with the change in the entry's name, and updates the state of the page.voidsetPageContainer(EntryPageContainer pageContainer) Sets the page container for this page.
- 
Constructor Details- 
DefaultEntryPagepublic DefaultEntryPage()
 
- 
- 
Method Details- 
applypublic final void apply()Being live, this method is completely ignored. Model is updated with every keystroke. So, there is no need to wait for this method to be called to actually make the changes to the model.
- 
createControlDescription copied from interface:EntryPageCreates 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:
- createControlin interface- EntryPage
- Parameters:
- parent- The Composite in which the Control has to be created
- entry- The entry whose properties have to be displayed
- See Also:
 
- 
createDescTextCreates theTextwhere the description of the entry is to be displayed.- Parameters:
- panel- The Composite in which the- Textis to be created
- Returns:
- The newly created Text
 
- 
createHiddenCheckBoxCreates theButton(CheckBox) for indicating the hidden status of the entry. It initializes it with the current hidden state of entry.- Parameters:
- panel- The Composite in which the Button is to be created
- Returns:
- The newly created Button
 
- 
createLabelCreates a label- Parameters:
- panel- The Composite in which the Label is to be created
- style- The stylebits for the Label
- text- The Label's text
- Returns:
- Label - The newly created Label
 
- 
createNameTextCreates the Text where the name of the entry is to be displayed.- Parameters:
- panel- The Composite in which the Text is to be created
- Returns:
- Text - The newly created Text
 
- 
createTextCreates aText. This method is mainly a result of code-factoring.- Parameters:
- panel- The Composite in which the Text is to be created
- style- The stylebits for the Text
- text- The text to be displayed in the Text
- Returns:
- a text widget with griddata constraint
 
- 
getControlDescription copied from interface:EntryPageReturns the Panel (Control) that displays the properties of the entry. This is the same Control that was created inEntryPage.createControl(Composite,PaletteEntry).- Specified by:
- getControlin interface- EntryPage
- Returns:
- the Control that displays the properties of the entry
- See Also:
 
- 
getEntryProvides sub-classes with access to the entry this class is monitoring.- Returns:
- PaletteEntry - The entry this class is monitoring
 
- 
getMessageSub-classes should override this method to provide appropriate error notification messages.- Returns:
- The message to be used when notifying listeners about a state change
 
- 
getPageContainer- Returns:
- The EntryPageContainerto which this page can report errors.
 
- 
handleDescriptionChangedUpdates the model with the change in the entry's description, and updates the state of the page. This method is invoked on every keystroke in the Text displaying the description of the entry. - Parameters:
- text- The new description
 
- 
handleHiddenSelectedprotected void handleHiddenSelected(boolean isChecked) Updates the model with the change in the entry's hidden state, and updates the state of the page. This method is invokes whenever the "Hidden" checkbox is selected. - Parameters:
- isChecked- The new selection value
 
- 
handleNameChangedUpdates the model with the change in the entry's name, and updates the state of the page. This method is invoked on every keystroke in the Text displaying the entry's name. - Parameters:
- text- The new name
 
- 
getPermissionprotected int getPermission()- Returns:
- the user permission on the entry
 
- 
setPageContainerDescription copied from interface:EntryPageSets the page container for this page. This page will report its errors to the given page container.- Specified by:
- setPageContainerin interface- EntryPage
- Parameters:
- pageContainer- The- EntryPageContainerto which this page can report errors
- See Also:
 
 
-