LayoutContext

All Superinterfaces:

Observable, Persistent

All Known Implementing Classes:

DefaultLayoutContext
```
public interface LayoutContext
extends Persistent, Observable
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addFFrame(IFFrame frame, boolean clearSelection, boolean select)` It adds a fframe to Arraylist of FFrames .
`void`	`addFFrameSameProperties(IFFrame frame)` It adds a fframe to Arraylist of FFrames with the same properties.
`void`	`addTocObserver(TocModelObserver observer)`
`void`	`clearSelection()` Clear the selection of FFrames.
`Iterator`	`deepiterator()` Get an Iterator over al elements in the layout.
`void`	`delFFrame(IFFrame frame)` Remove the fframe of parameter.
`void`	`delFFrame(int index)` Remove the fframe of index.
`void`	`delFFrameSelected()` Remove the fframes selected.
`void`	`fullRefresh()` Refresh all FFrames of Layout.
`IFFrame[]`	`getAllFFrames()` It returns all the fframes included them erased and modified in all its previous forms.
`AffineTransform`	`getAT()` Returns the AffineTransform that is applying in the Layout.
`Attributes`	`getAttributes()` It returns the print attributes of the Layout.
`IFFrame`	`getFFrame(int i)` It obtains the FFrame from an index.
`IFFrame[]`	`getFFrames()` It obtains the Array with all the FFrames that have been added al Layout.
`FrameCommandsRecord`	`getFrameCommandsRecord()` Returns the EditableFeatureSource, is the control of all change in the FFrames of Layout.
`int`	`getNumBefore()` Returns other number before the current fframes.
`int`	`getNumBehind()` Returns other number behind the current fframes.
`boolean`	`getRuler()` Returns if is shown or not the rule of the Layout.
`IFFrame[]`	`getSelectedFFrames()` Gets the list of selected FFrames
`<T> T[]`	`getSelectedFFrames(Class<T> clazz)` Gets the list of selected FFrames that are instance of the provided Class.
`MapContext`	`getTocModel()` Gets the model of the TOC.
`boolean`	`hasDocBeenOpened()` True when the document window has been opened at least once, false otherwise.
`boolean`	`isAdjustingToGrid()` It returns if has been applying in the fframes that are added to Layout the grid, or not.
`boolean`	`isEditable()` It returns if the Layout is in edition.
`boolean`	`isGridVisible()` It returns if has been showing the grid of Layout, or not.
`Iterator`	`iterator()`
`void`	`notifAllObservers()` Call all LayoutDrawListeners.
`void`	`notifyTocUpdated(TocModelChangedNotification.Type notificationType)` Triggers a notification to the TocModel observers of type `TocModelChangedNotification#MODEL_CHANGED`
`void`	`removeTocObserver(TocModelObserver observer)`
`void`	`removeTocObservers()`
`void`	`setAdjustToGrid(boolean b)` It inserts if has been applying in the fframes that are added to Layout the grid, or not.
`void`	`setAtributes(Attributes attributes)` Inserts the print attributes of Layout.
`void`	`setEditable(boolean b)` It inserts if the Layout is in edition.
`void`	`setGridVisible(boolean b)` It inserts if draws the Grid in the Layout or not.
`void`	`setHasDocBeenOpened(boolean hasBeenOpened)` True when the document window has been opened at least once, false otherwise.
`void`	`setNumBefore(int numBefore)`
`void`	`setNumBehind(int numBehind)`
`void`	`setRuler(boolean b)` It inserts if is shown or not the rule of the Layout.
`void`	`setTocModel(MapContext tocModel)` Sets the model of the TOC.
`void`	`updateFFrames()` It orders the FFrames depending on its position specified by level.

Methods inherited from interface org.gvsig.tools.persistence.Persistent
loadFromState, saveToState

Methods inherited from interface org.gvsig.tools.observer.Observable
addObserver, deleteObserver, deleteObservers

- Method Detail
  - getAT
```
AffineTransform getAT()
```
    Returns the AffineTransform that is applying in the Layout.
    
    Returns:
    
    AffineTransform
  - notifAllObservers
```
void notifAllObservers()
```
    Call all LayoutDrawListeners.
  - getAttributes
```
Attributes getAttributes()
```
    It returns the print attributes of the Layout.
    
    Returns:
    
    Attributes.
  - setAtributes
```
void setAtributes(Attributes attributes)
```
    Inserts the print attributes of Layout.
    
    Parameters:
    
    attributes - Attributes.
  - getFFrames
```
IFFrame[] getFFrames()
```
    It obtains the Array with all the FFrames that have been added al Layout.
    
    Returns:
    
    Array with all the FFrames that have been added al Layout.
  - getFFrame
```
IFFrame getFFrame(int i)
```
    It obtains the FFrame from an index.
  - updateFFrames
```
void updateFFrames()
```
    It orders the FFrames depending on its position specified by level.
  - delFFrameSelected
```
void delFFrameSelected()
```
    Remove the fframes selected.
  - clearSelection
```
void clearSelection()
```
    Clear the selection of FFrames.
  - delFFrame
```
void delFFrame(int index)
```
    Remove the fframe of index.
  - delFFrame
```
void delFFrame(IFFrame frame)
```
    Remove the fframe of parameter.
    
    Parameters:
    
    frame - FFrame to remove.
  - getFrameCommandsRecord
```
FrameCommandsRecord getFrameCommandsRecord()
```
    Returns the EditableFeatureSource, is the control of all change in the FFrames of Layout.
    
    Returns:
    
    EditableFatureSource.
  - addFFrame
```
void addFFrame(IFFrame frame,
               boolean clearSelection,
               boolean select)
```
    It adds a fframe to Arraylist of FFrames .
    
    Parameters:
    
    frame - fframe to add.
    
    clearSelection - True True if clean the selection of the fframes already added and false if intends to maintain the same selection.
    
    select - Boolean that indicates if has to remain selected the FFrame that is added or not.
  - addFFrameSameProperties
```
void addFFrameSameProperties(IFFrame frame)
```
    It adds a fframe to Arraylist of FFrames with the same properties.
    
    Parameters:
    
    frame - fframe to add.
  - getNumBehind
```
int getNumBehind()
```
    Returns other number behind the current fframes.
    
    Returns:
    
    new Position behind.
  - getNumBefore
```
int getNumBefore()
```
    Returns other number before the current fframes.
    
    Returns:
    
    new Position before.
  - getAllFFrames
```
IFFrame[] getAllFFrames()
```
    It returns all the fframes included them erased and modified in all its previous forms.
    
    Returns:
    
    IFFrame[] Array of FFrames.
  - getSelectedFFrames
```
IFFrame[] getSelectedFFrames()
```
    Gets the list of selected FFrames
    
    Returns:
    
    An Array of selected FFrames
  - getSelectedFFrames
```
<T> T[] getSelectedFFrames(Class<T> clazz)
```
    Gets the list of selected FFrames that are instance of the provided Class.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    clazz - A class
    
    Returns:
    
    An Array of selected FFrames
  - isEditable
```
boolean isEditable()
```
    It returns if the Layout is in edition.
    
    Returns:
    
    True if Layout is in edition.
  - setEditable
```
void setEditable(boolean b)
```
    It inserts if the Layout is in edition.
    
    Parameters:
    
    b - True if Layout is in edition.
  - isAdjustingToGrid
```
boolean isAdjustingToGrid()
```
    It returns if has been applying in the fframes that are added to Layout the grid, or not.
    
    Returns:
    
    true if has been applying the grid.
  - setAdjustToGrid
```
void setAdjustToGrid(boolean b)
```
    It inserts if has been applying in the fframes that are added to Layout the grid, or not.
    
    Parameters:
    
    b - true if has been applying the grid.
  - setRuler
```
void setRuler(boolean b)
```
    It inserts if is shown or not the rule of the Layout.
    
    Parameters:
    
    b - True if is shown or not the rule of the Layout.
  - getRuler
```
boolean getRuler()
```
    Returns if is shown or not the rule of the Layout.
    
    Returns:
    
    True si se muestra la regla.
  - isGridVisible
```
boolean isGridVisible()
```
    It returns if has been showing the grid of Layout, or not.
    
    Returns:
    
    true if has been showing the grid of Layout.
  - setGridVisible
```
void setGridVisible(boolean b)
```
    It inserts if draws the Grid in the Layout or not.
    
    Parameters:
    
    b - True if draws the Grid in the Layout.
  - fullRefresh
```
void fullRefresh()
```
    Refresh all FFrames of Layout.
  - setNumBehind
```
void setNumBehind(int numBehind)
```
  - setNumBefore
```
void setNumBefore(int numBefore)
```
  - setTocModel
```
void setTocModel(MapContext tocModel)
```
    Sets the model of the TOC. The LayoutPanel will create a TOC in the user interface if a tocModel has been set.
  - getTocModel
```
MapContext getTocModel()
```
    Gets the model of the TOC. The LayoutPanel will create a TOC in the user interface if a tocModel has been set.
  - notifyTocUpdated
```
void notifyTocUpdated(TocModelChangedNotification.Type notificationType)
```
    Triggers a notification to the TocModel observers of type TocModelChangedNotification#MODEL_CHANGED
  - addTocObserver
```
void addTocObserver(TocModelObserver observer)
```
  - removeTocObserver
```
void removeTocObserver(TocModelObserver observer)
```
  - removeTocObservers
```
void removeTocObservers()
```
  - hasDocBeenOpened
```
boolean hasDocBeenOpened()
```
    True when the document window has been opened at least once, false otherwise. This is required to decide whether the page setting dialog has to be shown to the user, otherwise it would be shown every time the document is opened from project persistence
  - setHasDocBeenOpened
```
void setHasDocBeenOpened(boolean hasBeenOpened)
```
    True when the document window has been opened at least once, false otherwise. This is required to decide whether the page setting dialog has to be shown to the user, otherwise it would be shown every time the document is opened from project persistence
  - deepiterator
```
Iterator deepiterator()
```
    Get an Iterator over al elements in the layout.
    
    Returns:
  - iterator
```
Iterator iterator()
```

Interface LayoutContext

Method Summary

Methods inherited from interface org.gvsig.tools.persistence.Persistent

Methods inherited from interface org.gvsig.tools.observer.Observable

Method Detail

getAT

notifAllObservers

getAttributes

setAtributes

getFFrames

getFFrame

updateFFrames

delFFrameSelected

clearSelection

delFFrame

delFFrame

getFrameCommandsRecord

addFFrame

addFFrameSameProperties

getNumBehind

getNumBefore

getAllFFrames

getSelectedFFrames

getSelectedFFrames

isEditable

setEditable

isAdjustingToGrid

setAdjustToGrid

setRuler

getRuler

isGridVisible

setGridVisible

fullRefresh

setNumBehind

setNumBefore

setTocModel

getTocModel

notifyTocUpdated

addTocObserver

removeTocObserver

removeTocObservers

hasDocBeenOpened

setHasDocBeenOpened

deepiterator

iterator