Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse GEF
3.3

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

java.lang.Object
  extended by
org.eclipse.gef.ui.palette.customize.DefaultEntryPage
All Implemented Interfaces:
EntryPage
Direct Known Subclasses:
DrawerEntryPage

public class DefaultEntryPage
extends java.lang.Object
implements EntryPage

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 Summary
DefaultEntryPage ()
           
 
Method Summary
 void apply ()
          Being live, this method is completely ignored.
 void createControl (Composite parent, PaletteEntry entry)
          Creates the Control that displays the properties of the given entry.
protected  Text createDescText (Composite panel)
          Creates the Text where the description of the entry is to be displayed.
protected  Button createHiddenCheckBox (Composite panel)
          Creates the Button (CheckBox) for indicating the hidden status of the entry.
protected  Label createLabel (Composite panel, int style, java.lang.String text)
          Creates a label
protected  Text createNameText (Composite panel)
          Creates the Text where the name of the entry is to be displayed.
protected  Text createText (Composite panel, int style, java.lang.String text)
          Creates a Text.
 Control getControl ()
          Returns the Panel (Control) that displays the properties of the entry.
protected   PaletteEntry getEntry ()
          Provides sub-classes with access to the entry this class is monitoring.
protected  java.lang.String getMessage ()
          Sub-classes should override this method to provide appropriate error notification messages.
protected   EntryPageContainer getPageContainer ()
           
protected  int getPermission ()
           
protected  void handleDescriptionChanged (java.lang.String text)
           Updates the model with the change in the entry's description, and updates the state of the page.
protected  void handleHiddenSelected (boolean isChecked)
           Updates the model with the change in the entry's hidden state, and updates the state of the page.
protected  void handleNameChanged (java.lang.String text)
           Updates the model with the change in the entry's name, and updates the state of the page.
 void setPageContainer ( EntryPageContainer pageContainer)
          Sets the page container for this page.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultEntryPage

public DefaultEntryPage()
Method Detail

apply

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

Specified by:
apply in interface EntryPage

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
Parameters:
parent - The Composite in which the Control has to be created
entry - The entry whose properties have to be displayed
See Also:
EntryPage.createControl(Composite, PaletteEntry)

createDescText

protected Text createDescText(Composite panel)
Creates the Text where the description of the entry is to be displayed.

Parameters:
panel - The Composite in which the Text is to be created
Returns:
The newly created Text

createHiddenCheckBox

protected Button createHiddenCheckBox(Composite panel)
Creates the Button (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

createLabel

protected Label createLabel(Composite panel,
                            int style,
                            java.lang.String text)
Creates 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

createNameText

protected Text createNameText(Composite panel)
Creates 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

createText

protected Text createText(Composite panel,
                          int style,
                          java.lang.String text)
Creates a Text. 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

getControl

public Control getControl()
Description copied from interface: EntryPage
Returns the Panel (Control) that displays the properties of the entry. This is the same Control that was created in EntryPage.createControl(Composite,PaletteEntry).

Specified by:
getControl in interface EntryPage
Returns:
the Control that displays the properties of the entry
See Also:
EntryPage.getControl()

getEntry

protected 
PaletteEntry getEntry()
Provides sub-classes with access to the entry this class is monitoring.

Returns:
PaletteEntry - The entry this class is monitoring

getMessage

protected java.lang.String getMessage()
Sub-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

protected 
EntryPageContainer getPageContainer()
Returns:
The EntryPageContainer to which this page can report errors.

handleDescriptionChanged

protected void handleDescriptionChanged(java.lang.String text)

Updates 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

handleHiddenSelected

protected 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

handleNameChanged

protected void handleNameChanged(java.lang.String text)

Updates 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

getPermission

protected int getPermission()
Returns:
the user permission on the entry

setPageContainer

public void setPageContainer(
EntryPageContainer pageContainer)
Description copied from interface: EntryPage
Sets the page container for this page. This page will report its errors to the given page container.

Specified by:
setPageContainer in interface EntryPage
Parameters:
pageContainer - The EntryPageContainer to which this page can report errors
See Also:
EntryPage.setPageContainer(EntryPageContainer)

Eclipse GEF
3.3

Copyright (c) IBM Corp. and others 2000, 2007. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire