com.sap.workspaces.module.extension

Class ViewOption

java.lang.Object
  com.sap.workspaces.module.extension.ViewOption

public class ViewOption
extends Object

Represents a module view option in the module tray menu

Since:

1.1

Nested Class Summary

static class	ViewOption.LaunchMode Contains constants that define how to launch the target of a tray option
static class	ViewOption.ViewInfo Represents a module view
static class	ViewOption.ViewType Defines the type of the module view

Constructor Summary

ViewOption(String label, ViewOption.LaunchMode mode, ViewOption.ViewInfo viewInfo, int position)
Use this constructor to launch the view either in place, or in a new window of the default size (600 x 400 pixels)

ViewOption(String label, ViewOption.LaunchMode mode, ViewOption.ViewInfo viewInfo, int position, int width, int height)
Use this constructor to launch the view in a new window of the specific size (in pixels)

Method Summary

int	getHeight() Returns the height of the new window in which to launch the view
String	getLabel() Returns the option's label in the tray menu
ViewOption.LaunchMode	getLaunchMode() Defines how to launch the view: in place or in a new window
int	getPosition() Returns the option's position in the tray menu
ViewOption.ViewInfo	getViewInfo() Returns the module view corresponding to the option
int	getWidth() Returns the width of the new window in which to launch the view

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewOption

public ViewOption(String label,
                  ViewOption.LaunchMode mode,
                  ViewOption.ViewInfo viewInfo,
                  int position)

Use this constructor to launch the view either in place, or in a new window of the default size (600 x 400 pixels)

ViewOption

public ViewOption(String label,
                  ViewOption.LaunchMode mode,
                  ViewOption.ViewInfo viewInfo,
                  int position,
                  int width,
                  int height)

Use this constructor to launch the view in a new window of the specific size (in pixels)

Method Detail

getWidth

public int getWidth()

Returns the width of the new window in which to launch the view

Returns:

The width of the new window in which to launch the view

getHeight

public int getHeight()

Returns the height of the new window in which to launch the view

Returns:

The height of the new window in which to launch the view

getPosition

public int getPosition()

Returns the option's position in the tray menu

Returns:

The option's position in the tray menu

getLabel

public String getLabel()

Returns the option's label in the tray menu

Returns:

The option's label in the tray menu

getViewInfo

public ViewOption.ViewInfo getViewInfo()

Returns the module view corresponding to the option

Returns:

The module view corresponding to the option

getLaunchMode

public ViewOption.LaunchMode getLaunchMode()

Defines how to launch the view: in place or in a new window

Returns:

The launch mode of the view