org.eclipse.datatools.sqltools.schemaobjecteditor.ui.internal.core
Class EditorPageDescriptor

java.lang.Object
  org.eclipse.datatools.sqltools.schemaobjecteditor.ui.internal.core.EditorPageDescriptor

All Implemented Interfaces:

IEditorPageDescriptor

public class EditorPageDescriptor
extends java.lang.Object
implements IEditorPageDescriptor

An instance of this class describe some static information of a page in a specific schema object editor.

Author:

Idull

Constructor Summary

EditorPageDescriptor(java.lang.String editorId, java.lang.String pageId, java.lang.String pageName, boolean beShown, boolean showByDefault, ISchemaObjectEditorPage page, IEditorDescriptor editor, org.eclipse.core.runtime.IConfigurationElement pageClassElement, java.lang.String pageExtensionId, java.lang.String contextHelpId, java.lang.String objectClassType)

Method Summary

java.lang.String	getContextHelpId() Returns the context help id
IEditorDescriptor	getEditor() Returns the instance of the editor in which this page is contained
java.lang.String	getEditorId() Returns the id of the editor in which this page is contained
java.lang.String	getObjectClassType() Returns the object class type for which the page is designed
ISchemaObjectEditorPage	getPageClass() Returns the page instance
java.lang.String	getPageExtensionId() Returns the page extension id defined in the extension, can be null
java.lang.String	getPageId() Returns the page id
java.lang.String	getPageName() Returns the page name
boolean	isRequired() Checks if this page is required (Must be visible)
boolean	isSelectedToShow() Checks if this page is visible or not
boolean	isVisible() Checks if the page is selected to be visible
boolean	isVisibleByDefault() Checks if the page is visible by default
void	setPageExtensionId(java.lang.String pageExtensionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorPageDescriptor

public EditorPageDescriptor(java.lang.String editorId,
                            java.lang.String pageId,
                            java.lang.String pageName,
                            boolean beShown,
                            boolean showByDefault,
                            ISchemaObjectEditorPage page,
                            IEditorDescriptor editor,
                            org.eclipse.core.runtime.IConfigurationElement pageClassElement,
                            java.lang.String pageExtensionId,
                            java.lang.String contextHelpId,
                            java.lang.String objectClassType)

Method Detail

getContextHelpId

public java.lang.String getContextHelpId()

Description copied from interface: IEditorPageDescriptor

Returns the context help id

Specified by:

getContextHelpId in interface IEditorPageDescriptor

Returns:

getEditor

public IEditorDescriptor getEditor()

Description copied from interface: IEditorPageDescriptor

Returns the instance of the editor in which this page is contained

Specified by:

getEditor in interface IEditorPageDescriptor

Returns:

getEditorId

public java.lang.String getEditorId()

Description copied from interface: IEditorPageDescriptor

Returns the id of the editor in which this page is contained

Specified by:

getEditorId in interface IEditorPageDescriptor

Returns:

getPageClass

public ISchemaObjectEditorPage getPageClass()

Description copied from interface: IEditorPageDescriptor

Returns the page instance

Specified by:

getPageClass in interface IEditorPageDescriptor

Returns:

getPageExtensionId

public java.lang.String getPageExtensionId()

Description copied from interface: IEditorPageDescriptor

Returns the page extension id defined in the extension, can be null

Specified by:

getPageExtensionId in interface IEditorPageDescriptor

Returns:

getPageId

public java.lang.String getPageId()

Description copied from interface: IEditorPageDescriptor

Returns the page id

Specified by:

getPageId in interface IEditorPageDescriptor

Returns:

getPageName

public java.lang.String getPageName()

Description copied from interface: IEditorPageDescriptor

Returns the page name

Specified by:

getPageName in interface IEditorPageDescriptor

Returns:

isRequired

public boolean isRequired()

Description copied from interface: IEditorPageDescriptor

Checks if this page is required (Must be visible)

Specified by:

isRequired in interface IEditorPageDescriptor

Returns:

isSelectedToShow

public boolean isSelectedToShow()

Description copied from interface: IEditorPageDescriptor

Checks if this page is visible or not

Specified by:

isSelectedToShow in interface IEditorPageDescriptor

Returns:

isVisibleByDefault

public boolean isVisibleByDefault()

Description copied from interface: IEditorPageDescriptor

Checks if the page is visible by default

Specified by:

isVisibleByDefault in interface IEditorPageDescriptor

Returns:

setPageExtensionId

public void setPageExtensionId(java.lang.String pageExtensionId)

getObjectClassType

public java.lang.String getObjectClassType()

Description copied from interface: IEditorPageDescriptor

Returns the object class type for which the page is designed

Specified by:

getObjectClassType in interface IEditorPageDescriptor

Returns:

isVisible

public boolean isVisible()

Description copied from interface: IEditorPageDescriptor

Checks if the page is selected to be visible

Specified by:

isVisible in interface IEditorPageDescriptor

Returns: