Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81455-03

# <af:masonryLayout>

af:masonryLayout masonryLayout masonry layout

UIComponent class: oracle.adf.view.rich.component.rich.layout.RichMasonryLayout
Component type: oracle.adf.RichMasonryLayout

The masonry layout component is a container that shows its children in a grid like a dashboard.

Child sizing:

Each direct child component must have a size style class applied to it that specifies the pixel size of that child and indicates how many columns and rows that child spans in the grid. The size style classes are named using the pattern 'AFMasonryTileSizeCxR', where C and R are numbers indicating the column and row spans of that child in the grid. The width and height attributes defined by the style class specify the pixel sizes corresponding to the grid spans. For example, 'AFMasonryTileSize2x1' indicates that a tile spans two columns and one row in the grid. The component provides predefined size style classes for spans from 1x1 up to and including 3x2 and 2x3.

An application may define additional size style classes for spans up to and including 10x10 through skinning. The style class names must follow the pattern described above.

Note about stretching layouts and flowing/scrolling layouts:

With today's web browsers, it is not reliable to have vertically-stretched content inside of areas that also have scroll bars. If you want the outer areas of your page structure to stretch, you need to be careful of how you assemble your component tree.

- First, build up a structure of stretchable components (using panelSplitters or panelGridLayouts).
- Second, inside of this structure, create islands of non-stretched content.

Rules of thumb:

1. Never nest one scrolling container inside of another scrolling container since users do not like nested scroll bars.
2. Never specify percentage heights in any component's inlineStyle attribute.
3. Never use the "position" style in any component's inlineStyle attribute.

If you believe that you need to break one of these rules, this is an indication that your page structure is not following the page structure guidelines and you will likely have troubles getting your application to render consistently across various web browsers and computing platforms.

- For specific details about component stretching, please see the "geometry management" section in the tag documentation of each component.
- See the demo application for real world layout examples that you can use as a starting point in your application. A good starting point is the "Layout Basics" page listed under the "Framework Features" tab of the demo application.

## Geometry Management

- This component can be stretched by a parent layout component that stretches its children, e.g. panelSplitter.
- This component will not stretch its child components.

## Screen Shot(s)

The masonry layout component is a container that shows its children in a grid like a dashboard.

## Code Example(s)

## Events

Type | Phases | Description
--- | --- | ---
oracle.adf.view.rich.event.MasonryDeleteEvent | Apply, Request, Values, Invoke, Application | The delete event is delivered when a child of the masonry layout is deleted.
oracle.adf.view.rich.event.MasonryInsertEvent | Apply, Request, Values, Invoke, Application | The insert event is delivered when a child is going to be inserted into a masonry layout.
oracle.adf.view.rich.event.MasonryReorderEvent | Apply, Request, Values, Invoke, Application | The reorder event is delivered when a child of the masonry layout is reordered.
oracle.adf.view.rich.event.MasonryResizeEvent | Apply, Request, Values, Invoke, Application | The resize event is delivered when a child of the masonry layout is resized.
org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke, Application, Apply, Request, Values | Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

## Attributes

Name | Type | Supports EL? | Description
attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding | oracle.adf.view.rich.component.rich.layout.RichMasonryLayout | Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
clientComponent | boolean | Yes | Default Value: false whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
customizationId | String | Yes | This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
deleteListener | javax.el.MethodExpression | Only EL | A method reference to a callback with the signature void method(oracle.adf.view.rich.event.MasonryDeleteEvent deleteEvent) called when a child of the masonry layout is deleted.
id | String | No | the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyle | String | Yes | the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
insertListener | javax.el.MethodExpression | Only EL | A method reference to a callback with the signature void method(oracle.adf.view.rich.event.MasonryInsertEvent insertEvent) called when a child is going to be inserted into the masonry layout.
partialTriggers | String[] | Yes | the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
rendered | boolean | Yes | Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
reorderListener | javax.el.MethodExpression | Only EL | A method reference to a callback with the signature void method(oracle.adf.view.rich.event.MasonryReorderEvent reorderEvent) called when a child of a masonry layout is reordered.
resizeListener | javax.el.MethodExpression | Only EL | A method reference to a callback with the signature void method(oracle.adf.view.rich.event.MasonryResizeEvent resizeEvent) called when a child of a masonry layout is resized.
shortDesc | String | Yes | the short description of the component. The shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. The behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
styleClass | String | Yes | a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
unsecure | java.util.Set | Yes | A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
visible | boolean | Yes | Default Value: true the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. Not supported on the following renderkits: org.apache.myfaces.trinidad.core