Layouts (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.ide.layout.Layouts

All Implemented Interfaces:

Addin, Displayable, Element, Folder
```
public class Layouts
extends java.lang.Object
implements Folder, Addin
```
This class manages layouts created by the user.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DATA_KEY`
`static java.lang.String`	`DESIGN_FILENAME`
`static java.lang.String`	`DESIGN_FILENAME_BASE`
`static java.lang.String`	`LAYOUT_EXT`

Constructor Summary

Constructors
Constructor and Description

Layouts()

Constructors
Constructor and Description
`Layouts()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`activate(Layout layout, java.util.HashMap listeners)`
`void`	`activateDefaultDesignLayout()`
`void`	`activateLayout(IdeLayout layout)`
`void`	`activateLayout(IdeLayout layout, boolean startup)`
`void`	`activateLayout(Layout child)`
`void`	`activatePreferredLayout(LayoutSelector selector)`
`boolean`	`add(Element element)` Add the specified Element from this Folder.
`void`	`addLayoutListener(java.lang.String viewName, LayoutListener listener)`
`void`	`addLayoutResetListener(LayoutResetListener l)` Adds the given listener to the list of listeners to notify when layouts are reset to original factory settings.
`void`	`addStartupLayoutListener(java.lang.String viewName, LayoutListener listener)`
`void`	`addView(ViewId id, View view)`
`java.net.URL`	`buildLayoutURL(java.lang.String baseName)` Build a layout URL using `baseName` as the unqualified file name.
`boolean`	`canAdd(Element element)` Other classes can call this method to determine whether the given `Element` can be added to the `Folder`.
`boolean`	`canRemove(Element element)` Other classes can call this method to determine whether the specified `Element` can be removed from this `Folder`.
`protected void`	`close(Layout layout)`
`boolean`	`containsChild(Element child)` Returns `true` if the folder contains the specified child `Element`; returns `false` otherwise.
`protected void`	`copyToImpl(Layouts copy)`
`boolean`	`equals(java.lang.Object o)`
`protected boolean`	`equalsImpl(Layouts other)`
`static IdeLayout`	`findLayout(java.lang.String name)`
`protected java.net.URL`	`generateLayoutURL()`
`Layout`	`getActive()`
`IdeLayout`	`getActiveLayout()` Returns the active layout.
`Layout`	`getActiveSubLayout()`
`java.util.Map<java.net.URL,Element>`	`getAllLayouts()` Returns map of all registered IdeLayouts.
`Attributes`	`getAttributes()` This method returns an `Attributes` object that encodes the attributes of the `Element`.
`protected static java.lang.String`	`getBaseName()`
`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.Object`	`getData()` Gets the data object that implements this interface.
`IdeLayout`	`getDesignLayout()`
`protected static java.net.URL`	`getDirectoryURL()`
`javax.swing.Icon`	`getIcon()` Returns an `Icon` that can be shown in association with this `Displayable`.
`BaseLayoutListener`	`getLayoutListener(java.lang.String type)`
`static Layouts`	`getLayouts()` Returns the active Layouts instance.
`java.lang.String`	`getLongLabel()` Gets a fully qualified label for display purpose.
`java.lang.String`	`getShortLabel()` Gets a short label for display purpose.
`java.lang.String`	`getToolTipText()` Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this `Displayable`.
`View`	`getView(ViewId id)`
`void`	`initialize()` Invoked by the `AddinManager` after the instance of the `Addin` is instantiated.
`boolean`	`isDesignActive()`
`boolean`	`isShowLayoutActivator()` Indicates whether or not the combo box used for layout activation should be shown in the toolbar.
`boolean`	`isUseActiveLayoutInEditor()` Indicates whether or not to use the active layout in the currently active editor.
`boolean`	`isUseEditorPreferredLayout()` Indicates whether or not editors should used their preferred layouts.
`java.util.List<LayoutResetListener>`	`layoutResetListeners()`
`boolean`	`mayHaveChildren()` This method is part of the `Element` interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the `instanceof` operator or having to downcast to a more specific type.
`Layout`	`newDesignLayout(java.net.URL url)` Creates a `SimpleLayout` owned by the Design layout.
`Layout`	`newLayout(IdeLayout parent)`
`Layout`	`newLayout(IdeLayout parent, java.net.URL fileURL)`
`boolean`	`remove(Element element)` Remove the specified Element from this Folder.
`void`	`removeAll()` Removes all children from the folder.
`void`	`removeLayoutResetListener(LayoutResetListener l)` Removes the given listener from the list of listeners to notify when layouts are reset to original factory settings.
`void`	`saveAll()`
`static void`	`setLayouts(Layouts layouts)` Sets the Layouts instance.
`void`	`setShowLayoutActivator(boolean showActivator)` Indicate whether or not the combo box used for layout activation should be shown in the toolbar.
`void`	`setUseActiveLayoutInEditor(boolean useActiveLayoutInEditor)` Indicate whether or not to use the active layout in the currently active editor.
`void`	`setUseEditorPreferredLayout(boolean useEditorPreferredLayout)` Indicate whether or not editors should use their preferred layouts.
`int`	`size()` Returns the current number of children in the folder.
`void`	`update(Layout layout)`
`protected void`	`update(Layout layout, java.util.Iterator iter)`
`protected void`	`updateStartupLayout()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.ide.model.Displayable
toString

- Field Detail
  - DATA_KEY
```
public static final java.lang.String DATA_KEY
```
    See Also:
    Constant Field Values
  - LAYOUT_EXT
```
public static final java.lang.String LAYOUT_EXT
```
    See Also:
    Constant Field Values
  - DESIGN_FILENAME_BASE
```
public static final java.lang.String DESIGN_FILENAME_BASE
```
    See Also:
    Constant Field Values
  - DESIGN_FILENAME
```
public static final java.lang.String DESIGN_FILENAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Layouts
```
public Layouts()
```
- Method Detail
  - getLayouts
```
public static Layouts getLayouts()
```
    Returns the active Layouts instance. This instance is usually created and initialized during startup.
  - setLayouts
```
public static void setLayouts(Layouts layouts)
```
    Sets the Layouts instance. This method is usually called only during startup.
  - addLayoutListener
```
public void addLayoutListener(java.lang.String viewName,
                     LayoutListener listener)
```
  - addStartupLayoutListener
```
public void addStartupLayoutListener(java.lang.String viewName,
                            LayoutListener listener)
```
  - initialize
```
public void initialize()
```
    Description copied from interface: Addin
    
    Invoked by the AddinManager after the instance of the Addin is instantiated. When invoked, The Addin should register and menu items, and actions required for use during this classes lifecycle. Addin authors should take care to ensure that any extraneous initialization is not preformed on this method, and any startup code that can be delayed until a later time is delayed, as the Addin's are synchronously initialized during the startup of the IDE, and each Addin has the potential to negatively impact the startup time of the product.
    
    Specified by:
    
    initialize in interface Addin
    
    See Also:
    AddinManager
  - getActiveLayout
```
public IdeLayout getActiveLayout()
```
    Returns the active layout.
  - getActiveSubLayout
```
public Layout getActiveSubLayout()
```
  - getActive
```
public Layout getActive()
```
  - activateLayout
```
public void activateLayout(IdeLayout layout)
```
  - activateLayout
```
public void activateLayout(IdeLayout layout,
                  boolean startup)
```
  - isDesignActive
```
public boolean isDesignActive()
```
  - activatePreferredLayout
```
public void activatePreferredLayout(LayoutSelector selector)
```
  - activateLayout
```
public void activateLayout(Layout child)
```
  - activateDefaultDesignLayout
```
public void activateDefaultDesignLayout()
```
  - buildLayoutURL
```
public java.net.URL buildLayoutURL(java.lang.String baseName)
```
    Build a layout URL using baseName as the unqualified file name. A file extension is added and the system directory is used as the parent directory.
  - newDesignLayout
```
public Layout newDesignLayout(java.net.URL url)
```
    Creates a SimpleLayout owned by the Design layout.
  - newLayout
```
public Layout newLayout(IdeLayout parent)
```
  - newLayout
```
public Layout newLayout(IdeLayout parent,
               java.net.URL fileURL)
```
  - getDesignLayout
```
public IdeLayout getDesignLayout()
```
  - update
```
public void update(Layout layout)
```
  - saveAll
```
public void saveAll()
```
  - getView
```
public View getView(ViewId id)
```
  - addView
```
public void addView(ViewId id,
           View view)
```
  - getLayoutListener
```
public BaseLayoutListener getLayoutListener(java.lang.String type)
```
  - getShortLabel
```
public java.lang.String getShortLabel()
```
    Gets a short label for display purpose.
    
    Specified by:
    
    getShortLabel in interface Displayable
    
    Returns:
    a short descriptive label. For example; an unqaualified file name.
  - getLongLabel
```
public java.lang.String getLongLabel()
```
    Gets a fully qualified label for display purpose.
    
    Specified by:
    
    getLongLabel in interface Displayable
    
    Returns:
    a long descriptive label. For example; a fully qualified file name.
  - getIcon
```
public javax.swing.Icon getIcon()
```
    Description copied from interface: Displayable
    
    Returns an Icon that can be shown in association with this Displayable. Typically the icon will be used in a tree control or list control. Therefore the icon must fit naturally within the space normally given to items within those controls. Such icons are usually 16x16 in size or, if there is a one-pixel transparent padding around the edge, 18x18 in size. It is strongly recommended that icons returned by this method be either 16x16 or 18x18 in size. If null is returned, the control may show a default icon, or it may show no icon, whichever is appropriate.
    
    Specified by:
    
    getIcon in interface Displayable
    
    Returns:
    the Icon for this node instance
  - mayHaveChildren
```
public boolean mayHaveChildren()
```
    Description copied from interface: Element
    
    This method is part of the Element interface to provide a convenient way of determining whether an object may have children 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 false from this method. An implementation of Element that could represent a non-leaf in a tree structure should return true from this method, even if it does not currently contain any children.
    
    Specified by:
    
    mayHaveChildren in interface Element
    
    Returns:
    true if this Element may contain children.
  - 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
    
    Returns:
    an Iterator of any children held by this Element, else null.
  - getToolTipText
```
public java.lang.String getToolTipText()
```
    Description copied from interface: Displayable
    
    Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel().
    
    Specified by:
    
    getToolTipText in interface Displayable
    
    Returns:
    the ToolTip for this node instance
  - getData
```
public java.lang.Object getData()
```
    Gets the data object that implements this interface.
    
    Specified by:
    
    getData in interface Element
    
    Returns:
    object implementing this interface.
  - getAttributes
```
public Attributes getAttributes()
```
    Description copied from interface: Element
    
    This method returns an Attributes object that encodes the attributes of the Element. Changing the attribute settings on the return object changes the element attributes. Subclasses should use their super class attributes object to define their own attributes. This allows subclasses to inherit their super class attributes. If a subclass does not wish to inherit attributes, they should first call getAttributes().clear() and define new attributes.
    
    Specified by:
    
    getAttributes in interface Element
    
    Returns:
    a bit field specifying whether the element is:
  - add
```
public boolean add(Element element)
```
    Add the specified Element from this Folder.
    
    Specified by:
    
    add in interface Folder
    
    Parameters:
    element - document to be added to this folder.
  - remove
```
public boolean remove(Element element)
```
    Remove the specified Element from this Folder.
    
    Specified by:
    
    remove in interface Folder
    
    Parameters:
    element - Element to be removed from this container.
  - canRemove
```
public boolean canRemove(Element element)
```
    Description copied from interface: Folder
    
    Other classes can call this method to determine whether the specified Element can be removed from this Folder.
    
    Specified by:
    
    canRemove in interface Folder
    
    Parameters:
    element - the Element being checked for removal from this folder
    
    Returns:
    TRUE if the specified element can be removed from this folder in the specified context. Quick responses are appreciated, since this method is used to enable/disable the Delete accelerator key in the Navigator with every context change.
  - canAdd
```
public boolean canAdd(Element element)
```
    Description copied from interface: Folder
    
    Other classes can call this method to determine whether the given Element can be added to the Folder.
    
    Specified by:
    
    canAdd in interface Folder
    
    Parameters:
    element - the Element that is about to be added to this Folder.
    
    Returns:
    true if the specified Element can be added to this Folder; false if the Element cannot be added.
  - containsChild
```
public boolean containsChild(Element child)
```
    Description copied from interface: Folder
    
    Returns true if the folder contains the specified child Element; returns false otherwise.
    
    Specified by:
    
    containsChild in interface Folder
  - size
```
public int size()
```
    Description copied from interface: Folder
    
    Returns the current number of children in the folder.
    
    Specified by:
    
    size in interface Folder
  - removeAll
```
public void removeAll()
```
    Description copied from interface: Folder
    
    Removes all children from the folder.
    
    Specified by:
    
    removeAll in interface Folder
  - isUseEditorPreferredLayout
```
public boolean isUseEditorPreferredLayout()
```
    Indicates whether or not editors should used their preferred layouts.
  - setUseEditorPreferredLayout
```
public void setUseEditorPreferredLayout(boolean useEditorPreferredLayout)
```
    Indicate whether or not editors should use their preferred layouts.
  - isShowLayoutActivator
```
public boolean isShowLayoutActivator()
```
    Indicates whether or not the combo box used for layout activation should be shown in the toolbar.
  - setShowLayoutActivator
```
public void setShowLayoutActivator(boolean showActivator)
```
    Indicate whether or not the combo box used for layout activation should be shown in the toolbar.
  - isUseActiveLayoutInEditor
```
public boolean isUseActiveLayoutInEditor()
```
    Indicates whether or not to use the active layout in the currently active editor.
  - setUseActiveLayoutInEditor
```
public void setUseActiveLayoutInEditor(boolean useActiveLayoutInEditor)
```
    Indicate whether or not to use the active layout in the currently active editor.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - equalsImpl
```
protected final boolean equalsImpl(Layouts other)
```
  - copyToImpl
```
protected final void copyToImpl(Layouts copy)
```
  - getBaseName
```
protected static java.lang.String getBaseName()
```
  - getDirectoryURL
```
protected static java.net.URL getDirectoryURL()
```
  - generateLayoutURL
```
protected java.net.URL generateLayoutURL()
```
  - close
```
protected void close(Layout layout)
```
  - activate
```
protected void activate(Layout layout,
            java.util.HashMap listeners)
```
  - updateStartupLayout
```
protected void updateStartupLayout()
```
  - update
```
protected void update(Layout layout,
          java.util.Iterator iter)
```
  - addLayoutResetListener
```
public void addLayoutResetListener(LayoutResetListener l)
```
    Adds the given listener to the list of listeners to notify when layouts are reset to original factory settings.
    
    Parameters:
    l - the listener to add.
  - removeLayoutResetListener
```
public void removeLayoutResetListener(LayoutResetListener l)
```
    Removes the given listener from the list of listeners to notify when layouts are reset to original factory settings.
    
    Parameters:
    l - the listener to remove.
  - layoutResetListeners
```
public java.util.List<LayoutResetListener> layoutResetListeners()
```
  - getAllLayouts
```
public java.util.Map<java.net.URL,Element> getAllLayouts()
```
    Returns map of all registered IdeLayouts.
    
    Returns:
    map of registered layoyuts.
  - findLayout
```
public static IdeLayout findLayout(java.lang.String name)
```

Class Layouts

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.ide.model.Displayable

Field Detail

DATA_KEY

LAYOUT_EXT

DESIGN_FILENAME_BASE

DESIGN_FILENAME

Constructor Detail

Layouts

Method Detail

getLayouts

setLayouts

addLayoutListener

addStartupLayoutListener

initialize

getActiveLayout

getActiveSubLayout

getActive

activateLayout

activateLayout

isDesignActive

activatePreferredLayout

activateLayout

activateDefaultDesignLayout

buildLayoutURL

newDesignLayout

newLayout

newLayout

getDesignLayout

update

saveAll

getView

addView

getLayoutListener

getShortLabel

getLongLabel

getIcon

mayHaveChildren

getChildren

getToolTipText

getData

getAttributes

add

remove

canRemove

canAdd

containsChild

size

removeAll

isUseEditorPreferredLayout

setUseEditorPreferredLayout

isShowLayoutActivator

setShowLayoutActivator

isUseActiveLayoutInEditor

setUseActiveLayoutInEditor

equals

equalsImpl

copyToImpl

getBaseName

getDirectoryURL

generateLayoutURL

close

activate

updateStartupLayout

update

addLayoutResetListener

removeLayoutResetListener

layoutResetListeners

getAllLayouts

findLayout