public abstract class Layout extends Node implements PropertyAccess
LOG_READONLY
Modifier | Constructor and Description |
---|---|
protected |
Layout(java.net.URL url) |
Modifier and Type | Method and Description |
---|---|
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 Element s without having to test the
object's type with the instanceof operator or having
to downcast to a more specific type. |
java.lang.String |
getDisplayName()
Get this display layout name.
|
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.
|
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, isLockHeld, isMigrating, isNew, isOpen, isReadLocked, isReadLockHeld, isReadOnly, isReadOrWriteLocked, isTrackingThreadNodeUsage, isWriteLocked, isWriteLockHeld, lockCount, markDirty, markDirtyImpl, mayHaveChildren, nodeLock, notifyObservers, open, openImpl, readLock, readLockCount, readLockInterruptibly, 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, writeLockInterruptibly, writeUnlock
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getProperty, removeProperty, setProperty
public java.util.Iterator getChildren()
Element
Element
interface to
provide a convenient way of getting an Iterator
over any
contained child Element
s 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 Element
s or
null
if there are no children.
getChildren
in interface Element
getChildren
in class Node
Iterator
over any child Element
s
contained by this Element
. If there are no children,
null
is returned.protected boolean isTrackedInNodeCache()
Node
true
. Node types that should not
be tracked by the NodeFactory cache should override this method
to return false
.isTrackedInNodeCache
in class Node
true
if this Node should be tracked by the
IDE's NodeFactory cache; false
otherwise.public boolean isActive() throws TransientMarker
TransientMarker
public void setActive(boolean active)
public java.lang.String getShortLabel()
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>".getShortLabel
in interface Displayable
getShortLabel
in class Node
Displayable
that can be shown to the user.public java.lang.String getName()
public java.lang.String getDisplayName()
public IdeLayout getOwner() throws TransientMarker
IdeLayout
that owns this layout.TransientMarker
public void setOwner(IdeLayout owner)
public final void setMenuFilter(MenuFilter filter)
filter
- the filter to select when the specified layout becomes
the active layout.public final MenuFilter getMenuFilter()
public java.lang.String toString()
Displayable
toString
method in java.lang.Object
.
Implementors of the Displayable
interface should
override this as appropriate. The default implementation is
the same as getShortLabel
toString
in interface Displayable
toString
in class Node
Object.toString()
,
Displayable.getShortLabel()