OME
Interface ViewObject

All Known Subinterfaces:
ViewElement, ViewLink

public interface ViewObject
extends OMEObject

This interface describes the methods that need to be implemented, when an object is to be represented in a view. These methods perform such operations as setting and getting the hidden status, iconified status and location of the object in the view.


Method Summary
 ViewObject getIcon()
          Returns the icon associated with this ViewObject, if one exists and null otherwise.
 View.Location getLocation()
          Returns the View.Location of this object.
 ModelObject getModelObject()
          Returns the model-side object which this ViewObject represents.
 boolean isHidden()
          Returns whether this object is hidden.
 boolean isHighlighted()
          Returns true iff this object is currently highlighted
 boolean isIconified()
          Returns whether this view element is iconified or not.
 boolean isSelected()
          Returns whether this object is selected or not.
 void setHidden(boolean hide)
          Sets whether this object is hidden.
 void setHighlighted(boolean highlight)
          Sets whether this object is highlighted
 void setIconified(ViewObject icon)
          Sets whether this view element is to be iconified or not.
 void setSelected(boolean select)
          Sets whether this object is selected.
 
Methods inherited from interface OME.OMEObject
addLink, getComment, getID, getLinks, getModel, getName, getType, setComment, setID, setName, setType
 

Method Detail

isHidden

public boolean isHidden()
Returns whether this object is hidden.

setHidden

public void setHidden(boolean hide)
Sets whether this object is hidden.
Parameters:
hide - the boolean value that indicates whether this object should be hidden or not.

setIconified

public void setIconified(ViewObject icon)
Sets whether this view element is to be iconified or not.
Parameters:
icon - the ViewObject that is our iconification. Passing null de-iconifies the object.

isIconified

public boolean isIconified()
Returns whether this view element is iconified or not. An element is iconified if
  • the element itself is iconified
  • the element's parent is iconified
  • or, the element's parent is not expanded.

  • getIcon

    public ViewObject getIcon()
    Returns the icon associated with this ViewObject, if one exists and null otherwise.

    getModelObject

    public ModelObject getModelObject()
    Returns the model-side object which this ViewObject represents.

    getLocation

    public View.Location getLocation()
    Returns the View.Location of this object.

    isSelected

    public boolean isSelected()
    Returns whether this object is selected or not.

    setSelected

    public void setSelected(boolean select)
    Sets whether this object is selected.
    Parameters:
    select - the boolean value that indicates whether this ViewObject should be selected or not.

    setHighlighted

    public void setHighlighted(boolean highlight)
    Sets whether this object is highlighted

    isHighlighted

    public boolean isHighlighted()
    Returns true iff this object is currently highlighted