Class: Layout::Layer

Inherits:

Object

• Object
• Layout::Layer

Overview

This is the interface to a LayOut Layer Definition. A layer definition specifies the document-wide information about a layer. To access the entities on a layer for a given page, use LayerInstance.

Examples:

# Grab a handle to an existing LayOut document.
doc = Layout::Document.open("C:/path/to/document.layout")

new_layer = doc.layers.add(true)
new_layer.name = "A new layer"

Version:

• LayOut 2018

Constant Summary

Layout::Layer::UNSHARELAYERACTION_CLEAR

Layout::Layer::UNSHARELAYERACTION_COPYTOONEPAGE

Layout::Layer::UNSHARELAYERACTION_COPYTOALLPAGES

Layout::Layer::SHARELAYERACTION_CLEAR

Layout::Layer::SHARELAYERACTION_KEEPONEPAGE

Layout::Layer::SHARELAYERACTION_MERGEALLPAGES

Instance Method Summary

• #==(other) ⇒ Boolean

  The #== method checks to see if the two Layers are equal.

• #document ⇒ Layout::Document

  The #document method returns the Document that the Layer belongs to.

• #layer_instance(page) ⇒ Object

  The #layer_instance method returns a LayerInstance from the Layer.

• #locked=(locked) ⇒ Object

  The #locked= method sets whether the Layer is locked.

• #locked? ⇒ Boolean

  The #locked? method returns whether the Layer is locked.

• #name ⇒ String

  The #name method returns the name of the Layer.

• #name=(name) ⇒ Object

  The #name= sets the name of the Layer.

• #set_nonshared(page, unshare_action) ⇒ Object

  The #set_nonshared method sets the Layer to non-shared.

• #set_shared(page, share_action) ⇒ Object

  The #set_shared method sets the Layer to shared.

• #shared? ⇒ Boolean

  The #shared? method returns whether the Layer is shared.

Instance Method Details

#==(other) ⇒ Boolean

The #== method checks to see if the two Layout::Layers are equal. This checks whether the Ruby Objects are pointing to the same internal object.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
document = doc.pages.first.document
doc.layers.first == document.layers.first

Parameters:

• other (Layout::Layer)

Returns:

• (Boolean)

Version:

• LayOut 2018

#document ⇒ Layout::Document

The #document method returns the Document that the Layout::Layer belongs to.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
first_layer = doc.layers.first
# layer_doc should reference the same document as doc
layer_doc = first_layer.document

Returns:

• (Layout::Document)

Version:

• LayOut 2018

#layer_instance ⇒ Layout::LayerInstance #layer_instance(page) ⇒ Layout::LayerInstance

The #layer_instance method returns a Layout::LayerInstance from the Layout::Layer. If the Layout::Layer is shared, a Page does not have to be provided.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
page = doc.pages.first
layer_instance = layers.first.layer_instance(page)

Overloads:

• #layer_instance ⇒ Layout::LayerInstance

  Returns:

  • (Layout::LayerInstance)
• #layer_instance(page) ⇒ Layout::LayerInstance

  Parameters:

  • page (Layout::Page)

  Returns:

  • (Layout::LayerInstance)

Raises:

• (ArgumentError) —

  if the Layout::Layer is not shared and no page is provided

Version:

• LayOut 2018

#locked=(locked) ⇒ Object

The #locked= method sets whether the Layout::Layer is locked.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
layers.first.locked = false

Parameters:

• locked (Boolean) —

  true to lock the Layout::Layer, false to unlock it

Raises:

• (ArgumentError) —

  if the Layout::Layer could not be locked because there must be at least one unlocked, visible Layout::Layer

Version:

• LayOut 2018

#locked? ⇒ Boolean

The #locked? method returns whether the Layout::Layer is locked.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
is_locked = layer.first.locked?

Returns:

• (Boolean)

Version:

• LayOut 2018

#name ⇒ String

The #name method returns the name of the Layout::Layer.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
layer_name = layers.first.name

Returns:

• (String)

Version:

• LayOut 2018

#name=(name) ⇒ Object

The #name= sets the name of the Layout::Layer.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
layers.first.name = "Base layer"

Parameters:

• name (String)

Raises:

• (ArgumentError) —

  if name is an empty string

Version:

• LayOut 2018

#set_nonshared(page, unshare_action) ⇒ Object

The #set_nonshared method sets the Layout::Layer to non-shared.

The unshare action can be one of the following values:

Layout::Layer::UNSHARELAYERACTION_CLEAR

Layout::Layer::UNSHARELAYERACTION_COPYTOONEPAGE

Layout::Layer::UNSHARELAYERACTION_COPYTOALLPAGES

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
page = doc.pages.first
layers.first.set_nonshared(page, Layout::Layer::UNSHARELAYERACTION_COPYTOONEPAGE);

Parameters:

• page (Layout::Page) —

  The Page with the Layout::Layer to be non-shared.

• unshare_action (Integer) —

  The share action that specifies what to do with Entitys after the Layout::Layer is non-shared.

Raises:

• (LockedLayerError) —

  if the Layout::Layer is locked

• (ArgumentError) —

  if unshare_action is not a valid value

Version:

• LayOut 2018

#set_shared(page, share_action) ⇒ Object

The #set_shared method sets the Layout::Layer to shared.

The share action can be one of the following values:

Layout::Layer::SHARELAYERACTION_CLEAR

Layout::Layer::SHARELAYERACTION_KEEPONEPAGE

Layout::Layer::SHARELAYERACTION_MERGEALLPAGES

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
page = doc.pages.first
layers.first.set_shared(page, Layout::Layer::SHARELAYERACTION_KEEPONEPAGE);

Parameters:

• page (Layout::Page) —

  The Page with the Layout::Layer to be shared.

• share_action (Integer) —

  The share action that specifies what to do with Entitys after the Layout::Layer is shared.

Raises:

• (Layout::LockedLayerError) —

  if the Layout::Layer is locked

• (ArgumentError) —

  if share_action is not a valid value

Version:

• LayOut 2018

#shared? ⇒ Boolean

The #shared? method returns whether the Layout::Layer is shared.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
layers = doc.layers
is_shared = layers.first.shared?

Returns:

• (Boolean)

Version:

• LayOut 2018