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.RoleAvailability Contains constants that define availability of module view options to various workspace roles
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)
Defines a view option that is launched either in place, or in a new window of the default size (600 x400 pixels)

ViewOption(String label, ViewOption.LaunchMode mode, ViewOption.ViewInfo viewInfo, int position, int width, int height)
Defines a view option that is launched in a new window of the specified width and height (in pixels)

ViewOption(String label, ViewOption.LaunchMode mode, ViewOption.ViewInfo viewInfo, int position, int width, int height, ViewOption.RoleAvailability roleAvailability)
Defines a view option that is launched in a new window of the specified width and height (in pixels), available for the specified workspace roles

ViewOption(String label, ViewOption.LaunchMode mode, ViewOption.ViewInfo viewInfo, int position, ViewOption.RoleAvailability roleAvailability)
Defines a view option that is launched either in place, or in a new window of the default width and height (600 x400 pixels), available for the specified workspace roles

Method Summary

ViewOption.RoleAvailability	getAvailability() Returns the option’s availability for workspace roles
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() Returns the launch mode of the view
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
void	setAvailability(ViewOption.RoleAvailability availability) Defines the option’s availability for workspace roles

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)

Defines a view option that is launched either in place, or in a new window of the default size (600 x400 pixels)

ViewOption

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

Defines a view option that is launched in a new window of the specified width and height (in pixels)

ViewOption

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

Defines a view option that is launched either in place, or in a new window of the default width and height (600 x400 pixels), available for the specified workspace roles

Since:

1.1 SP02

ViewOption

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

Defines a view option that is launched in a new window of the specified width and height (in pixels), available for the specified workspace roles

Since:

1.1 SP02

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()

Returns the launch mode of the view

Returns:

The launch mode of the view: either in place or in a new window

getAvailability

public ViewOption.RoleAvailability getAvailability()

Returns the option’s availability for workspace roles

Returns:

The option’s availability for workspace roles, such as managers and members

Since:

1.1 SP02

setAvailability

public void setAvailability(ViewOption.RoleAvailability availability)

Defines the option’s availability for workspace roles

Since:

1.1 SP02