Layout (sforce-tooling-api 35.0 API)

java.lang.Object
- com.sforce.soap.tooling.metadata.Metadata
- - com.sforce.soap.tooling.metadata.Layout

public class Layout
extends Metadata

Java class for Layout complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Layout">
   <complexContent>
     <extension base="{urn:metadata.tooling.soap.sforce.com}Metadata">
       <sequence>
         <element name="customButtons" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="customConsoleComponents" type="{urn:metadata.tooling.soap.sforce.com}CustomConsoleComponents" minOccurs="0"/>
         <element name="emailDefault" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="excludeButtons" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="feedLayout" type="{urn:metadata.tooling.soap.sforce.com}FeedLayout" minOccurs="0"/>
         <element name="headers" type="{urn:tooling.soap.sforce.com}LayoutHeader" maxOccurs="unbounded" minOccurs="0"/>
         <element name="layoutSections" type="{urn:metadata.tooling.soap.sforce.com}LayoutSection" maxOccurs="unbounded" minOccurs="0"/>
         <element name="miniLayout" type="{urn:metadata.tooling.soap.sforce.com}MiniLayout" minOccurs="0"/>
         <element name="multilineLayoutFields" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="quickActionList" type="{urn:metadata.tooling.soap.sforce.com}QuickActionList" minOccurs="0"/>
         <element name="relatedContent" type="{urn:metadata.tooling.soap.sforce.com}RelatedContent" minOccurs="0"/>
         <element name="relatedLists" type="{urn:metadata.tooling.soap.sforce.com}RelatedListItem" maxOccurs="unbounded" minOccurs="0"/>
         <element name="relatedObjects" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="runAssignmentRulesDefault" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showEmailCheckbox" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showHighlightsPanel" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showInteractionLogPanel" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showKnowledgeComponent" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showRunAssignmentRulesCheckbox" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showSolutionSection" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="showSubmitAndAttachButton" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="summaryLayout" type="{urn:metadata.tooling.soap.sforce.com}SummaryLayout" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`customButtons`
`protected CustomConsoleComponents`	`customConsoleComponents`
`protected Boolean`	`emailDefault`
`protected List<String>`	`excludeButtons`
`protected FeedLayout`	`feedLayout`
`protected List<LayoutHeader>`	`headers`
`protected List<LayoutSection>`	`layoutSections`
`protected MiniLayout`	`miniLayout`
`protected List<String>`	`multilineLayoutFields`
`protected QuickActionList`	`quickActionList`
`protected RelatedContent`	`relatedContent`
`protected List<RelatedListItem>`	`relatedLists`
`protected List<String>`	`relatedObjects`
`protected Boolean`	`runAssignmentRulesDefault`
`protected Boolean`	`showEmailCheckbox`
`protected Boolean`	`showHighlightsPanel`
`protected Boolean`	`showInteractionLogPanel`
`protected Boolean`	`showKnowledgeComponent`
`protected Boolean`	`showRunAssignmentRulesCheckbox`
`protected Boolean`	`showSolutionSection`
`protected Boolean`	`showSubmitAndAttachButton`
`protected SummaryLayout`	`summaryLayout`

Constructor Summary

Constructors
Constructor and Description

Layout()

Constructors
Constructor and Description
`Layout()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getCustomButtons()` Gets the value of the customButtons property.
`CustomConsoleComponents`	`getCustomConsoleComponents()` Gets the value of the customConsoleComponents property.
`List<String>`	`getExcludeButtons()` Gets the value of the excludeButtons property.
`FeedLayout`	`getFeedLayout()` Gets the value of the feedLayout property.
`List<LayoutHeader>`	`getHeaders()` Gets the value of the headers property.
`List<LayoutSection>`	`getLayoutSections()` Gets the value of the layoutSections property.
`MiniLayout`	`getMiniLayout()` Gets the value of the miniLayout property.
`List<String>`	`getMultilineLayoutFields()` Gets the value of the multilineLayoutFields property.
`QuickActionList`	`getQuickActionList()` Gets the value of the quickActionList property.
`RelatedContent`	`getRelatedContent()` Gets the value of the relatedContent property.
`List<RelatedListItem>`	`getRelatedLists()` Gets the value of the relatedLists property.
`List<String>`	`getRelatedObjects()` Gets the value of the relatedObjects property.
`SummaryLayout`	`getSummaryLayout()` Gets the value of the summaryLayout property.
`Boolean`	`isEmailDefault()` Gets the value of the emailDefault property.
`Boolean`	`isRunAssignmentRulesDefault()` Gets the value of the runAssignmentRulesDefault property.
`Boolean`	`isShowEmailCheckbox()` Gets the value of the showEmailCheckbox property.
`Boolean`	`isShowHighlightsPanel()` Gets the value of the showHighlightsPanel property.
`Boolean`	`isShowInteractionLogPanel()` Gets the value of the showInteractionLogPanel property.
`Boolean`	`isShowKnowledgeComponent()` Gets the value of the showKnowledgeComponent property.
`Boolean`	`isShowRunAssignmentRulesCheckbox()` Gets the value of the showRunAssignmentRulesCheckbox property.
`Boolean`	`isShowSolutionSection()` Gets the value of the showSolutionSection property.
`Boolean`	`isShowSubmitAndAttachButton()` Gets the value of the showSubmitAndAttachButton property.
`void`	`setCustomConsoleComponents(CustomConsoleComponents value)` Sets the value of the customConsoleComponents property.
`void`	`setEmailDefault(Boolean value)` Sets the value of the emailDefault property.
`void`	`setFeedLayout(FeedLayout value)` Sets the value of the feedLayout property.
`void`	`setMiniLayout(MiniLayout value)` Sets the value of the miniLayout property.
`void`	`setQuickActionList(QuickActionList value)` Sets the value of the quickActionList property.
`void`	`setRelatedContent(RelatedContent value)` Sets the value of the relatedContent property.
`void`	`setRunAssignmentRulesDefault(Boolean value)` Sets the value of the runAssignmentRulesDefault property.
`void`	`setShowEmailCheckbox(Boolean value)` Sets the value of the showEmailCheckbox property.
`void`	`setShowHighlightsPanel(Boolean value)` Sets the value of the showHighlightsPanel property.
`void`	`setShowInteractionLogPanel(Boolean value)` Sets the value of the showInteractionLogPanel property.
`void`	`setShowKnowledgeComponent(Boolean value)` Sets the value of the showKnowledgeComponent property.
`void`	`setShowRunAssignmentRulesCheckbox(Boolean value)` Sets the value of the showRunAssignmentRulesCheckbox property.
`void`	`setShowSolutionSection(Boolean value)` Sets the value of the showSolutionSection property.
`void`	`setShowSubmitAndAttachButton(Boolean value)` Sets the value of the showSubmitAndAttachButton property.
`void`	`setSummaryLayout(SummaryLayout value)` Sets the value of the summaryLayout property.

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

- Field Detail
  - customButtons
```
protected List<String> customButtons
```
  - customConsoleComponents
```
protected CustomConsoleComponents customConsoleComponents
```
  - emailDefault
```
protected Boolean emailDefault
```
  - excludeButtons
```
protected List<String> excludeButtons
```
  - feedLayout
```
protected FeedLayout feedLayout
```
  - headers
```
protected List<LayoutHeader> headers
```
  - layoutSections
```
protected List<LayoutSection> layoutSections
```
  - miniLayout
```
protected MiniLayout miniLayout
```
  - multilineLayoutFields
```
protected List<String> multilineLayoutFields
```
  - quickActionList
```
protected QuickActionList quickActionList
```
  - relatedContent
```
protected RelatedContent relatedContent
```
  - relatedLists
```
protected List<RelatedListItem> relatedLists
```
  - relatedObjects
```
protected List<String> relatedObjects
```
  - runAssignmentRulesDefault
```
protected Boolean runAssignmentRulesDefault
```
  - showEmailCheckbox
```
protected Boolean showEmailCheckbox
```
  - showHighlightsPanel
```
protected Boolean showHighlightsPanel
```
  - showInteractionLogPanel
```
protected Boolean showInteractionLogPanel
```
  - showKnowledgeComponent
```
protected Boolean showKnowledgeComponent
```
  - showRunAssignmentRulesCheckbox
```
protected Boolean showRunAssignmentRulesCheckbox
```
  - showSolutionSection
```
protected Boolean showSolutionSection
```
  - showSubmitAndAttachButton
```
protected Boolean showSubmitAndAttachButton
```
  - summaryLayout
```
protected SummaryLayout summaryLayout
```
- Constructor Detail
  - Layout
```
public Layout()
```
- Method Detail
  - getCustomButtons
```
public List<String> getCustomButtons()
```
    Gets the value of the customButtons property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the customButtons property.
    For example, to add a new item, do as follows:
```
    getCustomButtons().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getCustomConsoleComponents
```
public CustomConsoleComponents getCustomConsoleComponents()
```
    Gets the value of the customConsoleComponents property.
    
    Returns:
    
    possible object is CustomConsoleComponents
  - setCustomConsoleComponents
```
public void setCustomConsoleComponents(CustomConsoleComponents value)
```
    Sets the value of the customConsoleComponents property.
    
    Parameters:
    
    value - allowed object is CustomConsoleComponents
  - isEmailDefault
```
public Boolean isEmailDefault()
```
    Gets the value of the emailDefault property.
    
    Returns:
    
    possible object is Boolean
  - setEmailDefault
```
public void setEmailDefault(Boolean value)
```
    Sets the value of the emailDefault property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getExcludeButtons
```
public List<String> getExcludeButtons()
```
    Gets the value of the excludeButtons property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the excludeButtons property.
    For example, to add a new item, do as follows:
```
    getExcludeButtons().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getFeedLayout
```
public FeedLayout getFeedLayout()
```
    Gets the value of the feedLayout property.
    
    Returns:
    
    possible object is FeedLayout
  - setFeedLayout
```
public void setFeedLayout(FeedLayout value)
```
    Sets the value of the feedLayout property.
    
    Parameters:
    
    value - allowed object is FeedLayout
  - getHeaders
```
public List<LayoutHeader> getHeaders()
```
    Gets the value of the headers property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the headers property.
    For example, to add a new item, do as follows:
```
    getHeaders().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LayoutHeader
  - getLayoutSections
```
public List<LayoutSection> getLayoutSections()
```
    Gets the value of the layoutSections property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the layoutSections property.
    For example, to add a new item, do as follows:
```
    getLayoutSections().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LayoutSection
  - getMiniLayout
```
public MiniLayout getMiniLayout()
```
    Gets the value of the miniLayout property.
    
    Returns:
    
    possible object is MiniLayout
  - setMiniLayout
```
public void setMiniLayout(MiniLayout value)
```
    Sets the value of the miniLayout property.
    
    Parameters:
    
    value - allowed object is MiniLayout
  - getMultilineLayoutFields
```
public List<String> getMultilineLayoutFields()
```
    Gets the value of the multilineLayoutFields property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the multilineLayoutFields property.
    For example, to add a new item, do as follows:
```
    getMultilineLayoutFields().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getQuickActionList
```
public QuickActionList getQuickActionList()
```
    Gets the value of the quickActionList property.
    
    Returns:
    
    possible object is QuickActionList
  - setQuickActionList
```
public void setQuickActionList(QuickActionList value)
```
    Sets the value of the quickActionList property.
    
    Parameters:
    
    value - allowed object is QuickActionList
  - getRelatedContent
```
public RelatedContent getRelatedContent()
```
    Gets the value of the relatedContent property.
    
    Returns:
    
    possible object is RelatedContent
  - setRelatedContent
```
public void setRelatedContent(RelatedContent value)
```
    Sets the value of the relatedContent property.
    
    Parameters:
    
    value - allowed object is RelatedContent
  - getRelatedLists
```
public List<RelatedListItem> getRelatedLists()
```
    Gets the value of the relatedLists property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the relatedLists property.
    For example, to add a new item, do as follows:
```
    getRelatedLists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list RelatedListItem
  - getRelatedObjects
```
public List<String> getRelatedObjects()
```
    Gets the value of the relatedObjects property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the relatedObjects property.
    For example, to add a new item, do as follows:
```
    getRelatedObjects().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - isRunAssignmentRulesDefault
```
public Boolean isRunAssignmentRulesDefault()
```
    Gets the value of the runAssignmentRulesDefault property.
    
    Returns:
    
    possible object is Boolean
  - setRunAssignmentRulesDefault
```
public void setRunAssignmentRulesDefault(Boolean value)
```
    Sets the value of the runAssignmentRulesDefault property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowEmailCheckbox
```
public Boolean isShowEmailCheckbox()
```
    Gets the value of the showEmailCheckbox property.
    
    Returns:
    
    possible object is Boolean
  - setShowEmailCheckbox
```
public void setShowEmailCheckbox(Boolean value)
```
    Sets the value of the showEmailCheckbox property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowHighlightsPanel
```
public Boolean isShowHighlightsPanel()
```
    Gets the value of the showHighlightsPanel property.
    
    Returns:
    
    possible object is Boolean
  - setShowHighlightsPanel
```
public void setShowHighlightsPanel(Boolean value)
```
    Sets the value of the showHighlightsPanel property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowInteractionLogPanel
```
public Boolean isShowInteractionLogPanel()
```
    Gets the value of the showInteractionLogPanel property.
    
    Returns:
    
    possible object is Boolean
  - setShowInteractionLogPanel
```
public void setShowInteractionLogPanel(Boolean value)
```
    Sets the value of the showInteractionLogPanel property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowKnowledgeComponent
```
public Boolean isShowKnowledgeComponent()
```
    Gets the value of the showKnowledgeComponent property.
    
    Returns:
    
    possible object is Boolean
  - setShowKnowledgeComponent
```
public void setShowKnowledgeComponent(Boolean value)
```
    Sets the value of the showKnowledgeComponent property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowRunAssignmentRulesCheckbox
```
public Boolean isShowRunAssignmentRulesCheckbox()
```
    Gets the value of the showRunAssignmentRulesCheckbox property.
    
    Returns:
    
    possible object is Boolean
  - setShowRunAssignmentRulesCheckbox
```
public void setShowRunAssignmentRulesCheckbox(Boolean value)
```
    Sets the value of the showRunAssignmentRulesCheckbox property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowSolutionSection
```
public Boolean isShowSolutionSection()
```
    Gets the value of the showSolutionSection property.
    
    Returns:
    
    possible object is Boolean
  - setShowSolutionSection
```
public void setShowSolutionSection(Boolean value)
```
    Sets the value of the showSolutionSection property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isShowSubmitAndAttachButton
```
public Boolean isShowSubmitAndAttachButton()
```
    Gets the value of the showSubmitAndAttachButton property.
    
    Returns:
    
    possible object is Boolean
  - setShowSubmitAndAttachButton
```
public void setShowSubmitAndAttachButton(Boolean value)
```
    Sets the value of the showSubmitAndAttachButton property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getSummaryLayout
```
public SummaryLayout getSummaryLayout()
```
    Gets the value of the summaryLayout property.
    
    Returns:
    
    possible object is SummaryLayout
  - setSummaryLayout
```
public void setSummaryLayout(SummaryLayout value)
```
    Sets the value of the summaryLayout property.
    
    Parameters:
    
    value - allowed object is SummaryLayout

Class Layout

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

customButtons

customConsoleComponents

emailDefault

excludeButtons

feedLayout

headers

layoutSections

miniLayout

multilineLayoutFields

quickActionList

relatedContent

relatedLists

relatedObjects

runAssignmentRulesDefault

showEmailCheckbox

showHighlightsPanel

showInteractionLogPanel

showKnowledgeComponent

showRunAssignmentRulesCheckbox

showSolutionSection

showSubmitAndAttachButton

summaryLayout

Constructor Detail

Layout

Method Detail

getCustomButtons

getCustomConsoleComponents

setCustomConsoleComponents

isEmailDefault

setEmailDefault

getExcludeButtons

getFeedLayout

setFeedLayout

getHeaders

getLayoutSections

getMiniLayout

setMiniLayout

getMultilineLayoutFields

getQuickActionList

setQuickActionList

getRelatedContent

setRelatedContent

getRelatedLists

getRelatedObjects

isRunAssignmentRulesDefault

setRunAssignmentRulesDefault

isShowEmailCheckbox

setShowEmailCheckbox

isShowHighlightsPanel

setShowHighlightsPanel

isShowInteractionLogPanel

setShowInteractionLogPanel

isShowKnowledgeComponent

setShowKnowledgeComponent

isShowRunAssignmentRulesCheckbox

setShowRunAssignmentRulesCheckbox

isShowSolutionSection

setShowSolutionSection

isShowSubmitAndAttachButton

setShowSubmitAndAttachButton

getSummaryLayout

setSummaryLayout