com.cc.framework.ui.model
Class SchedulerScope

java.lang.Object
  com.cc.framework.ui.model.SchedulerScope

All Implemented Interfaces:

java.io.Serializable, SimpleEnumType

public class SchedulerScope

extends java.lang.Object

implements SimpleEnumType, java.io.Serializable

Specifies where to show checkboxes in a scheduler control

Version:

$Revision$

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private static SchedulerScope[]	ALL Collection with all enumeration elements
static SchedulerScope	APPOINTMENT The control will be displayed in appointment view
private int	bit An ordinal value for the bit position in a scope mask
static SchedulerScope	DAY The control will be displayed in day view
static int	MASK_ALL Mask for all views
private static long	serialVersionUID Serial Version UID
private java.lang.String	view The internal view name

Constructor Summary

private

SchedulerScope(java.lang.String view, int bit) Constructor for SchedulerCheckRange

Method Summary

boolean	equals(java.lang.Object obj) Compares this type to the specified object.
int	hashCode()
boolean	isInMask(int viewMask) Checks if the view is contained in the given mask
int	mask()
static SchedulerScope	parse(java.lang.String code) Creates for the argument an object of type SchedulerCheckRange
static int	parseMask(java.lang.String viewList) Converts the semicolon delimited list of views into a view mask
java.lang.String	toString() Returns the SchedulerCheckRange

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

MASK_ALL

public static final int MASK_ALL

Mask for all views

See Also:

Constant Field Values

APPOINTMENT

public static final SchedulerScope APPOINTMENT

The control will be displayed in appointment view

DAY

public static final SchedulerScope DAY

The control will be displayed in day view

view

private java.lang.String view

The internal view name

bit

private int bit

An ordinal value for the bit position in a scope mask

ALL

private static final SchedulerScope[] ALL

Collection with all enumeration elements

Constructor Detail

SchedulerScope

private SchedulerScope(java.lang.String view,
                       int bit)

Constructor for SchedulerCheckRange

Parameters:

view - Specifies where to show checkboxes in a scheduler control

bit - Ordinal value for the bit position in a scope mask

Method Detail

mask

public int mask()

Returns:

returns a bit mask for this view

toString

public java.lang.String toString()

Returns the SchedulerCheckRange

Returns:

The SchedulerCheckRange

isInMask

public boolean isInMask(int viewMask)

Checks if the view is contained in the given mask

Parameters:

viewMask - The View Mask to test

Returns:

true if the view is set in the mask

equals

public boolean equals(java.lang.Object obj)

Compares this type to the specified object.

Parameters:

obj - The object to compare this SchedulerCheckRange object against.

Returns:

true if the internal types are equal; false otherwise.

hashCode

public int hashCode()

See Also:

Object.hashCode()

parse

public static SchedulerScope parse(java.lang.String code)

Creates for the argument an object of type SchedulerCheckRange

Parameters:

code - String to parse

Returns:

The new Object

parseMask

public static int parseMask(java.lang.String viewList)

Converts the semicolon delimited list of views into a view mask

Parameters:

viewList - semicolon delimited list of views or "true" for all possible views or "false"Returns:

bit mask