oracle.ide.layout
Class Layout

java.lang.Object
  oracle.ide.model.Node
      oracle.ide.layout.Layout

All Implemented Interfaces:

Displayable, Element, LazyLoadable, Locatable, Subject, PropertyAccess, Dirtyable

Direct Known Subclasses:

IdeLayout, SimpleLayout

public abstract class Layout
extends Node
implements PropertyAccess

Layout interface. Layouts remember the position of views. When a layout is activated, the state of the remembered views is recovered from the information saved in the layout.

Field Summary

Fields inherited from class oracle.ide.model.Node

LOG_READONLY

Constructor Summary

protected

Layout(java.net.URL url)

Method Summary

java.util.Iterator	getChildren() This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.
MenuFilter	getMenuFilter() Returns the current menu filter for this layout.
java.lang.String	getName() Get this layout name.
IdeLayout	getOwner() Get the IdeLayout that owns this layout.
java.lang.String	getShortLabel() Displayable interface method.
boolean	isActive() Returns true if this layout is currently active.
protected boolean	isTrackedInNodeCache() The return value of this method indicates whether this Node should be tracked by the NodeFactory cache.
void	setActive(boolean active) Mark this layout as the currently active layout.
void	setMenuFilter(MenuFilter filter) Registers a menu filter for the layout.
void	setOwner(IdeLayout owner) Set the owner of this layout.
java.lang.String	toString() Returns the Short Label displayed to a user.

Methods inherited from class oracle.ide.model.Node

addNodeListener, addNodeListenerForType, addNodeListenerForTypeHierarchy, attach, beginThreadNodeUsageCycle, callUnderReadLock, callUnderWriteLock, close, closeImpl, createSubject, delete, deleteImpl, detach, endThreadNodeUsage, endThreadNodeUsageCycle, ensureOpen, equalsImpl, getAttributes, getData, getIcon, getInputStream, getLongLabel, getSubject, getTimestamp, getTimestampLoadedUnsafe, getToolTipText, getTransientProperties, getUnmodifiedTimestamp, getURL, isDirty, isLoaded, isMigrating, isNew, isOpen, isReadLocked, isReadOnly, isReadOrWriteLocked, isWriteLocked, lockCount, markDirty, markDirtyImpl, mayHaveChildren, nodeLock, notifyObservers, open, openImpl, readLock, readLockCount, readUnlock, refreshTimestamp, removeNodeListener, removeNodeListenerForType, removeNodeListenerForTypeHierarchy, rename, renameImpl, reportOpenException, revert, revertImpl, runUnderReadLock, runUnderWriteLock, save, saveImpl, setEventLog, setMigrating, setOpen, setReadOnly, setTimestampDirectly, setURL, tryRunUnderReadLock, tryRunUnderWriteLock, unsetMigrating, upgradeLock, upgradeUnlock, urlReadOnlyChanged, writeLock, writeLockCount, writeUnlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ide.util.PropertyAccess

getProperty, removeProperty, setProperty

Constructor Detail

Layout

protected Layout(java.net.URL url)

Method Detail

getChildren

public java.util.Iterator getChildren()

Description copied from interface: Element

This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.

An implementation of Element that represents a leaf in a tree structure should return null from this method. An implementation of Element that could represent a non-leaf in a tree structure should return either an Iterator over the child Elements or null if there are no children.

Specified by:

getChildren in interface Element

Overrides:

getChildren in class Node

Returns:

an Iterator over any child Elements contained by this Element. If there are no children, null is returned.

isTrackedInNodeCache

protected boolean isTrackedInNodeCache()

Description copied from class: Node

The return value of this method indicates whether this Node should be tracked by the NodeFactory cache. The default return value is true. Node types that should not be tracked by the NodeFactory cache should override this method to return false.

Overrides:

isTrackedInNodeCache in class Node

Returns:

true if this Node should be tracked by the IDE's NodeFactory cache; false otherwise.

isActive

public boolean isActive()
                 throws TransientMarker

Returns true if this layout is currently active.

Throws:

TransientMarker

setActive

public void setActive(boolean active)

Mark this layout as the currently active layout.

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Node

Displayable interface method. The Node class returns the file name part of the currently set URL. If the currently set URL is null, then this method returns "<null>".

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class Node

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getName

public java.lang.String getName()

Get this layout name.

getOwner

public IdeLayout getOwner()
                   throws TransientMarker

Get the IdeLayout that owns this layout.

Throws:

TransientMarker

setOwner

public void setOwner(IdeLayout owner)

Set the owner of this layout.

setMenuFilter

public final void setMenuFilter(MenuFilter filter)

Registers a menu filter for the layout. When the layout is activated, the menus will be automatically adjusted to only show items that are selected by the filter.

Parameters:

filter - the filter to select when the specified layout becomes the active layout.

Since:

11.0

getMenuFilter

public final MenuFilter getMenuFilter()

Returns the current menu filter for this layout.

Returns:

the menu filter for this layout.

toString

public java.lang.String toString()

Description copied from interface: Displayable

Returns the Short Label displayed to a user. This overrides the toString method in java.lang.Object.

Implementors of the Displayable interface should override this as appropriate. The default implementation is the same as getShortLabel

Specified by:

toString in interface Displayable

Overrides:

toString in class Node

See Also:

Object.toString(), Displayable.getShortLabel()