org.opencms.workplace.explorer
Class CmsExplorerContextMenuItem

java.lang.Object
  extended byorg.opencms.workplace.explorer.CmsExplorerContextMenuItem
All Implemented Interfaces:
java.lang.Comparable

public class CmsExplorerContextMenuItem
extends java.lang.Object
implements java.lang.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 java.lang.String TYPE_ENTRY
          The name for an entry type.
static java.lang.String TYPE_SEPARATOR
          The name for a separator type.
 
Constructor Summary
CmsExplorerContextMenuItem(java.lang.String type, java.lang.String key, java.lang.String uri, java.lang.String rules, java.lang.String target, java.lang.Integer order)
          Constructor that creates a single context menu entry with all necessary information.
 
Method Summary
 java.lang.Object clone()
           
 int compareTo(java.lang.Object obj)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getKey()
          Returns the key for localization.
 java.lang.Integer getOrder()
          Returns the sort order of this item.
 java.lang.String getRules()
          Returns the set of display rules.
 java.lang.String getTarget()
          Returns the frame target of the current item.
 java.lang.String getType()
          Returns the type of the current item.
 java.lang.String getUri()
          Returns the dialog URI of the current item.
 int hashCode()
           
 void setKey(java.lang.String key)
          Sets the key for localization.
 void setOrder(java.lang.Integer order)
          Returns the sort order of this item.
 void setRules(java.lang.String rules)
          Sets the set of display rules.
 void setTarget(java.lang.String target)
          Sets the frame target of the current item.
 void setType(java.lang.String type)
          Sets the type of the current item.
 void setUri(java.lang.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 java.lang.String TYPE_ENTRY
The name for an entry type.

See Also:
Constant Field Values

TYPE_SEPARATOR

public static final java.lang.String TYPE_SEPARATOR
The name for a separator type.

See Also:
Constant Field Values
Constructor Detail

CmsExplorerContextMenuItem

public CmsExplorerContextMenuItem(java.lang.String type,
                                  java.lang.String key,
                                  java.lang.String uri,
                                  java.lang.String rules,
                                  java.lang.String target,
                                  java.lang.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 java.lang.Object clone()
See Also:
Object.clone()

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable
See Also:
Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)
See Also:
Object.equals(java.lang.Object)

getKey

public java.lang.String getKey()
Returns the key for localization.

Returns:
the key for localization

getOrder

public java.lang.Integer getOrder()
Returns the sort order of this item.

Returns:
the sort order of this item

getRules

public java.lang.String getRules()
Returns the set of display rules.

Returns:
the set of display rules

getTarget

public java.lang.String getTarget()
Returns the frame target of the current item.

Returns:
the frame target of the current item

getType

public java.lang.String getType()
Returns the type of the current item.

Returns:
the type of the current item

getUri

public java.lang.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(java.lang.String key)
Sets the key for localization.

Parameters:
key - the key for localization

setOrder

public void setOrder(java.lang.Integer order)
Returns the sort order of this item.

Parameters:
order - the sort order of this item

setRules

public void setRules(java.lang.String rules)
Sets the set of display rules.

Parameters:
rules - the set of display rules

setTarget

public void setTarget(java.lang.String target)
Sets the frame target of the current item.

Parameters:
target - the frame target of the current item

setType

public void setType(java.lang.String type)
Sets the type of the current item.

Parameters:
type - the type of the current item

setUri

public void setUri(java.lang.String uri)
Sets the dialog URI of the current item.

Parameters:
uri - the dialog URI of the current item