Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * See the NOTICE file distributed with this work for additional
   * information regarding copyright ownership.
   *
   * This is free software; you can redistribute it and/or modify it
   * under the terms of the GNU Lesser General Public License as
   * published by the Free Software Foundation; either version 2.1 of
   * the License, or (at your option) any later version.
   *
  * This software is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this software; if not, write to the Free
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
 package org.xwiki.rendering.macro.box;
 
 import java.util.List;
 
Parameters for the Box macro.

Version:
$Id: d80c6eddb208b67dbfc1e46854334ae376736328 $
 
 public class BoxMacroParameters
 {
    

See also:
getCssClass()
 
     private String cssClass = .;

    

See also:
getTitle()
 
     private String title = .;

    

See also:
getImage()
 
     private ResourceReference imageReference;

    

See also:
getWidth()
 
     private String width = .;

    

See also:
getTitle()
 
     private List<? extends BlockblockTitle;

    
Optionally, the title can contain a list of Blocks, for more flexibility, instead of storing only ordinary text.

Returns:
the title represented as a list of Blocks
 
     public List<? extends BlockgetBlockTitle()
     {
         return this.;
     }

    

Parameters:
blockTitle - refer to getBlockTitle()
 
     @PropertyHidden
     public void setBlockTitle(List<? extends BlockblockTitle)
     {
         this. = blockTitle;
     }

    

Returns:
the title to be displayed in the message box. Note that it can contain content in the current syntax and that text which will be parsed and rendered as any syntax content
 
     public String getTitle()
     {
         return this.;
     }

    

Parameters:
title refer to getTitle()
 
     @PropertyDescription("the title which is to be displayed in the message box")
     public void setTitle(String title)
     {
         this. = title;
     }

    

Returns:
the reference to the image to display in the message box.
    public ResourceReference getImage()
    {
        return this.;
    }

    

Parameters:
imageReference see getImage()
    @PropertyDescription("the reference to the image to display in the message box")
    public void setImage(ResourceReference imageReference)
    {
        this. = imageReference;
    }

    

Returns:
an optional class parameter value to use when rendering the Box. The XHTML renderer for example uses it on the surrounding SPAN (in case the box is used inline) or on the surrounding DIV (in case the box is used standalone). This allows the user to provide CSS to style the box according to his needs. Example: {code cssClass="mybox"}. If not specified, the BoxMacro.getClassProperty() is used to provide a default one.
    public String getCssClass()
    {
        return this.;
    }

    

Parameters:
cssClass refer to getCssClass()
    @PropertyDescription("A CSS class to add to the box element")
    public void setCssClass(String cssClass)
    {
        this. = cssClass;
    }

    

Returns:
an optional width to enforce as an inline style on the DIV element the box will be formed of.
    public String getWidth()
    {
        return this.;
    }

    

Parameters:
width refer to getWidth()
    @PropertyDescription("An optional width for the box, expressed in px or %")
    public void setWidth(String width)
    {
        this. = width;
    }
New to GrepCode? Check out our FAQ X