com.sap.portal.admin.editor
Class PaneMetaData

java.lang.Object
  |
  +--com.sap.portal.admin.editor.PaneMetaData

public class PaneMetaData

extends java.lang.Object

PaneMetaData Structure class that holds the pane meta data such as name and title. By default each pane is part of the pane selection group, and does not have an activating event.

Constructor Summary

PaneMetaData(java.lang.Class paneClass, java.lang.String title)
Creates a new PaneMetaData object.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getActivatingEvent()
java.lang.String	getDescription()
java.lang.Class	getPaneClass()
java.lang.String	getTitle()
boolean	isPaneSelectionMember()
void	setActivatingEvent(java.lang.String activatingEvent) Set the event that need to be raised in oreder to get to this pane
void	setDescription(java.lang.String description)
void	setPaneSelectionMember(boolean b) Set whether this pane will appear in the pane selection group on the top of the editor.
void	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaneMetaData

public PaneMetaData(java.lang.Class paneClass,
                    java.lang.String title)

Creates a new PaneMetaData object.

Parameters:

paneClass - the class of the pane that this meta data refers to

title - The title of this pane- must be NLS

Method Detail

setActivatingEvent

public void setActivatingEvent(java.lang.String activatingEvent)

Set the event that need to be raised in oreder to get to this pane

Parameters:

activatingEvent - name of event

getActivatingEvent

public java.lang.String getActivatingEvent()

Returns:

the name of the event that activates this pane

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description of this pane (will appear in the tooltip)

getDescription

public java.lang.String getDescription()

Returns:

the description of this pane (will appear in the tooltip)

getPaneClass

public java.lang.Class getPaneClass()

Returns:

the name of the pane class

setPaneSelectionMember

public void setPaneSelectionMember(boolean b)

Set whether this pane will appear in the pane selection group on the top of the editor.

Parameters:

true - (default) if this pane should appear in the pane selection group

isPaneSelectionMember

public boolean isPaneSelectionMember()

Returns:

true if this pane will appear in the pane selection group on the top of the editor.

setTitle

public void setTitle(java.lang.String title)

Parameters:

title - the title of this pane

getTitle

public java.lang.String getTitle()

Returns:

the title of this pane

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object