com.sap.portal.admin.editor

Class PaneMetaData

java.lang.Object

com.sap.portal.admin.editor.PaneMetaData

public class PaneMetaData
extends Object

The class that represents the pane metadata.
An editor contains one or more panes that contain the input fields, buttons and other controls that make up the user interface. An editor with a single visible pane displays the title of the pane in the title bar of the editor, just below the toolbar. An editor with more than one visible pane displays in the title bar a radio button group that enables the user to navigate between panes.
By default each pane is part of the pane selection group, and does not have an activating event. The pane selection group is a radio button group that enables the administrator to select the pane to be displayed.

Constructor Summary

Constructors

Constructor and Description
PaneMetaData(Class paneClass, String title) A constructor that sets the title of the pane.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getActivatingEvent() Gets the event that activates a pane.
String	getDescription() Gets the pane description.
Class	getPaneClass() Gets the name of the pane class.
String	getTitle() Gets the title for the pane.
int	hashCode()
boolean	isPaneSelectionMember() Indicates whether the pane appears in the pane selection group at the top of the editor.
void	setActivatingEvent(String activatingEvent) Sets an event that activates a pane.
void	setDescription(String description) Sets a description for the pane to display in the tooltip.
void	setPaneSelectionMember(boolean isPaneSelectionMember) Sets whether the pane appears in the pane selection group at the top of the editor.
void	setTitle(String title) Sets a title for the pane.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaneMetaData

public PaneMetaData(Class paneClass,
                    String title)

A constructor that sets the title of the pane.

Parameters:

paneClass - a pane class

title - a title for the pane in NLS format

Method Detail

setActivatingEvent

public void setActivatingEvent(String activatingEvent)

Sets an event that activates a pane.

Parameters:

activatingEvent - an event

getActivatingEvent

public String getActivatingEvent()

Gets the event that activates a pane.

Returns:

the event

setDescription

public void setDescription(String description)

Sets a description for the pane to display in the tooltip.

Parameters:

description - a tooltip

getDescription

public String getDescription()

Gets the pane description.

Returns:

the tooltip

getPaneClass

public Class getPaneClass()

Gets the name of the pane class.

Returns:

the name of the pane class

setPaneSelectionMember

public void setPaneSelectionMember(boolean isPaneSelectionMember)

Sets whether the pane appears in the pane selection group at the top of the editor. The default is true.

Parameters:

isPaneSelectionMember - true creates a radio button for this pane in the pane selection group, false does not create a radio button for this pane.

isPaneSelectionMember

public boolean isPaneSelectionMember()

Indicates whether the pane appears in the pane selection group at the top of the editor.

Returns:

true if this pane appears in the pane selection group, false if it does not

setTitle

public void setTitle(String title)

Sets a title for the pane.

Parameters:

title - a title for the pane

getTitle

public String getTitle()

Gets the title for the pane.

Returns:

the title of the pane

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object