org.opencms.workplace.explorer
Class CmsExplorerContextMenuItem

java.lang.Object
  org.opencms.workplace.explorer.CmsExplorerContextMenuItem

All Implemented Interfaces:

Comparable

public class CmsExplorerContextMenuItem

extends Object

implements Comparable

Provides information about a single context menu item for a resource type in the OpenCms explorer view.

An item can be a context menu entry or a separator line.

Since:

6.0.0

Version:

$Revision: 1.9 $

Author:

Andreas Zahner

Field Summary

static String	TYPE_ENTRY The name for an entry type.
static String	TYPE_SEPARATOR The name for a separator type.

Constructor Summary

CmsExplorerContextMenuItem(String type, String key, String uri, String rules, String target, Integer order)
Constructor that creates a single context menu entry with all necessary information.

Method Summary

Object	clone()
int	compareTo(Object obj)
boolean	equals(Object obj)
String	getKey() Returns the key for localization.
Integer	getOrder() Returns the sort order of this item.
String	getRules() Returns the set of display rules.
String	getTarget() Returns the frame target of the current item.
String	getType() Returns the type of the current item.
String	getUri() Returns the dialog URI of the current item.
int	hashCode()
void	setKey(String key) Sets the key for localization.
void	setOrder(Integer order) Returns the sort order of this item.
void	setRules(String rules) Sets the set of display rules.
void	setTarget(String target) Sets the frame target of the current item.
void	setType(String type) Sets the type of the current item.
void	setUri(String uri) Sets the dialog URI of the current item.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ENTRY

public static final String TYPE_ENTRY

The name for an entry type.

See Also:

Constant Field Values

TYPE_SEPARATOR

public static final String TYPE_SEPARATOR

The name for a separator type.

See Also:

Constant Field Values

Constructor Detail

CmsExplorerContextMenuItem

public CmsExplorerContextMenuItem(String type,
                                  String key,
                                  String uri,
                                  String rules,
                                  String target,
                                  Integer order)

Constructor that creates a single context menu entry with all necessary information.

Parameters:

type - the item type (entry oder separator)

key - the key for localization

uri - the URI of the dialog

rules - the set of display rules

target - the frame target of the entry (e.g. "_top")

order - the order of the item

Method Detail

clone

public Object clone()

See Also:

Object.clone()

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

See Also:

Object.equals(java.lang.Object)

getKey

public String getKey()

Returns the key for localization.

Returns:

the key for localization

getOrder

public Integer getOrder()

Returns the sort order of this item.

Returns:

the sort order of this item

getRules

public String getRules()

Returns the set of display rules.

Returns:

the set of display rules

getTarget

public String getTarget()

Returns the frame target of the current item.

Returns:

the frame target of the current item

getType

public String getType()

Returns the type of the current item.

Returns:

the type of the current item

getUri

public String getUri()

Returns the dialog URI of the current item.

Returns:

the dialog URI of the current item

hashCode

public int hashCode()

See Also:

Object.hashCode()

setKey

public void setKey(String key)

Sets the key for localization.

Parameters:

key - the key for localization

setOrder

public void setOrder(Integer order)

Returns the sort order of this item.

Parameters:

order - the sort order of this item

setRules

public void setRules(String rules)

Sets the set of display rules.

Parameters:

rules - the set of display rules

setTarget

public void setTarget(String target)

Sets the frame target of the current item.

Parameters:

target - the frame target of the current item

setType

public void setType(String type)

Sets the type of the current item.

Parameters:

type - the type of the current item

setUri

public void setUri(String uri)

Sets the dialog URI of the current item.

Parameters:

uri - the dialog URI of the current item